Class: Mushikago::Hotaru::Client

Inherits:
Mushikago::Http::Client show all
Defined in:
lib/mushikago/hotaru/client.rb

Overview

Hotaruサービスを利用する

Examples:

client = Mushikago::Hotaru::Client.new(:api_key => '<api_key>', :secret_key => '<secret_key>')

client.capture('http://www.hotaru.ne.jp/', :thumbnail => true, :tags => ['hotaru', 'webservice'])

captures = client.captures
captures['images'].each do |image|
  puts image['image_url']
end

APIキーをファイルから読み込む場合 

Mushikago.config.load(YAML.load(File.read('config.yml')))
client = Mushikago::Hotaru::Client.new

Instance Attribute Summary

Attributes inherited from Mushikago::Http::Client

api_key, signer

Instance Method Summary (collapse)

Methods inherited from Mushikago::Http::Client

#initialize, #send_request

Constructor Details

This class inherits a constructor from Mushikago::Http::Client

Instance Method Details

- (Mushikago::Http::Response) capture(url, options = {})

指定したURLのキャプチャを取得する

Examples:

client.capture('http://www.hotaru.ne.jp/', :thumbnail => true, :tags => ['hotaru', 'webservice'])

Parameters:

  • url (String) —

    キャプチャ対象のURL

  • options (Hash) (defaults to: {}) —

    リクエストのオプション

Options Hash (options):

  • :image_format('jpg') (String) —

    画像のフォーマット(jpg,png)

  • :image_quality(80) (Integer) —

    画像の品質(0-100)

  • :thumbnail(0) (Boolean) —

    サムネイル取得フラグ(false:取得しない,true:取得する)

  • :tags (String, Array) —

    タグ

Returns:



31
32
33
34
 
# File 'lib/mushikago/hotaru/client.rb', line 31

def capture url, options={}
  request = CaptureRequest.new(url, options)
  send_request(request)
end

- (Mushikago::Http::Response) captures(options = {})

いままでキャプチャした画像の情報を取得する

Examples:

client.captures(:tag => 'webservice')

Parameters:

  • options (Hash) (defaults to: {}) —

    リクエストのオプション

Options Hash (options):

  • :id (String) —

    画像のID

  • :domain (String) —

    指定したドメインの画像一覧を取得する

  • :tag (String) —

    指定したタグの画像一覧を取得する

  • :limit(10) (Integer) —

    最大取得件数(1-100)

  • :offset(0) (Integer) —

    取得オフセット

Returns:



47
48
49
50
 
# File 'lib/mushikago/hotaru/client.rb', line 47

def captures options={}
  request = CapturesRequest.new(options)
  send_request(request)
end

- (Mushikago::Http::Response) delete(id, options = {})

指定した画像を削除する

Examples:

client.delete('5a6cdfa3-xxx3-47d6-8xxx-5f83af6b66cc')

Parameters:

  • id (String) —

    画像のID

  • options (Hash) (defaults to: {}) —

    リクエストのオプション

Returns:



59
60
61
62
 
# File 'lib/mushikago/hotaru/client.rb', line 59

def delete id, options={}
  request = DeleteRequest.new(id, options)
  send_request(request)
end

- (Mushikago::Http::Response) info(options = {})

APIの使用状況を取得する

Examples:

client.info

Parameters:

  • options (Hash) (defaults to: {}) —

    リクエストのオプション

Returns:



70
71
72
73
 
# File 'lib/mushikago/hotaru/client.rb', line 70

def info options={}
  request = InfoRequest.new(options)
  send_request(request)
end