bitly下載 - bitly加源代碼下載

bitly

其他源碼

1.0.0

下載

咬人

Ruby Gem，用於使用版本4 Bitly API縮短鏈接，擴展跨用戶，鏈接和組織之間的指標。

安裝
用法

驗證
創建API客戶端
縮短鏈接
展開鏈接

可用的API端點

組
組織
用戶
位鏈接
自定義位鏈接
廣告系列
BSD（品牌短域）
Webhooks

自定義HTTP請求

構建自己的適配器

發展
貢獻
執照
行為守則

安裝

將此行添加到您的應用程序的gemfile：

寶石'bitly'

然後執行：

 $捆綁安裝

或自行安裝：

 $ gem安裝bitly

用法

要快速介紹，請閱讀此博客文章，介紹瞭如何在Ruby中使用Bitly API。

驗證

所有API端點都需要使用OAuth代幣進行身份驗證。您可以從Bitly Console中獲得自己的OAuth令牌。單擊“帳戶下拉菜單”，然後單擊“配置”設置，然後進行通用訪問令牌。填寫密碼，您可以生成OAuth訪問令牌。

有關通過OAuth流量為用戶生成訪問令牌的其他方法，請參見身份驗證文檔。

擁有訪問令牌後，您可以使用所有API方法。

創建API客戶端

所有API方法均可通過Bitly::API::Client獲得。用訪問令牌像這樣初始化客戶端：

 client = bitly :: api :: client.new（token：token）

然後，您可以使用客戶端使用API執行操作

縮短鏈接

使用經過身份驗證的客戶端，您可以縮短這樣的鏈接：

 bitlink = client.shorten（long_url：“ http：//example.com”）bitlink.link＃=> http://bit.ly/2oujim0

展開鏈接

通過授權，您可以擴展任何位鏈接。

 bitlink = client.expand（bitlink：“ bit.ly/2oujim0")Bitlink.long_url# => http://example.com

可用的API端點

該GEM支持以下API的以下活動V4 API端點。

組

組文檔

組織

組織文檔

檢索組織（ GET /v4/organizations ）
檢索組織（ GET /v4/organizations/{organization_guid} ）
檢索組織縮短計數（ GET /v4/organizations/{organization_guid}/shorten_counts ）

用戶

用戶文檔

檢索用戶（ GET /v4/user ）
更新用戶（ PATCH /v4/user ）

位鏈接

位鏈接文檔

自定義位鏈接

添加自定義位鏈接（ POST /v4/custom_bitlinks ）
[premium]檢索自定義位鏈接（ GET /v4/custom_bitlinks/{custom_bitlink} ）
[premium]更新自定義位鏈接（ PATCH /v4/custom_bitlinks/{custom_bitlink} ）
[premium]獲取目標定制位鏈接的指標（ GET /v4/custom_bitlinks/{custom_bitlink}/clicks_by_destination ）
[premium]獲取自定義Bitlin的整個歷史記錄的單擊（ GET /v4/custom_bitlinks/{custom_bitlink}/clicks ）

廣告系列

[Premium]檢索廣告系列（ GET /v4/campaigns ）
[premium]創建廣告系列（ POST /v4/campaigns ）
[premium]檢索廣告系列（ GET /v4/campaigns/{campaign_guid} ）
[premium]更新廣告系列（ PATCH /v4/campaigns/{campaign_guid} ）
[premium]檢索頻道（ GET /v4/channels ）
[premium]創建頻道（ POST /v4/channels ）
[premium]檢索頻道（ GET /v4/channels/{channel_guid} ）
[premium]更新頻道（ PATCH /v4/channels/{channel_guid} ）

BSD（品牌短域）

品牌的短域文檔

檢索BSD（ GET /v4/bsds ）

Webhooks

[premium]獲取webhooks（ GET /v4/organizations/{organization_guid}/webhooks ）
[premium]創建一個webhook（ POST /v4/webhooks ）
[premium]檢索webhook（ GET /v4/webhooks/{webhook_guid} ）
[premium]更新webhook（ POST /v4/webhooks/{webhook_guid ）
[premium]刪除webhook（ DELETE /v4/webhooks/{webhook_guid} ）
[premium]驗證一個webhook（ POST /v4/webhooks/{webhook_guid}/verify ）

自定義HTTP請求

該寶石帶有一個可以使用不同適配器的HTTP客戶端。它默認使用了Net::HTTP適配器。

如果要控制連接，則可以創建自己的Net::HTTP適配器的實例，並將其傳遞給HTTP代理或控制請求的選項。例如，要控制read_timeout您可以執行此操作：

 adapter = bitly :: http :: apapters :: nethttp.new（request_options：{read_timeout：1}） ：http_client，令牌：令牌）

同樣，您可以通過將代理變量傳遞給適配器的構造函數，將適配器的HTTP代理使用。

 aDapter = bitly :: http :: apapters :: nethttp.new（proxy_addr：“ xample.com”，proxy_port：80，proxy_user：“ username”，proxy_pass：protxy_pass：“ password”） （適配器）api_client = bitly :: api :: client.new（http：http_client，token：token）

構建自己的適配器

如果您想對請求進行更多的控制，則可以構建自己的適配器。此GEM中的HTTP適配器必須具有接收一個Bitly::HTTP::Request對象的request實例方法並返回四個對象的數組：

響應狀態代碼
響應的正文作為字符串
響應標題作為哈希
布爾值表示響應是否成功

有關示例，請參見./src/bitly/http/adapters/net_http.rb 。

發展

檢查回購後，運行bin/setup以安裝依賴關係。然後，運行rake spec以運行測試。您還可以運行bin/console以獲得交互提示，該提示可以讓您進行實驗。

要將此GEM安裝到本地計算機上，請運行bundle exec rake install 。要發布新版本，請在version.rb中更新版本號，然後運行bundle exec rake release ，該版本將為版本創建一個git標籤，推送git consits and tags，然後將.gem文件推到rubygems.org。