Class: Grackle::Client

Inherits:

Object

• Object
• Grackle::Client

show all

Defined in:

lib/grackle/client.rb

Overview

client = Grackle.Client.new(:auth=>{:type=>:basic,:username=>'twitteruser',:password=>'secret'})

client = Grackle.Client.new(:username=>'twitteruser',:password=>'secret') #deprecated

client = Grackle::Client.new(:auth=>{
  :type=>:oauth,
  :consumer_key=>'SOMECONSUMERKEYFROMTWITTER, :consumer_secret=>'SOMECONSUMERTOKENFROMTWITTER',
  :token=>'ACCESSTOKENACQUIREDONUSERSBEHALF', :token_secret=>'SUPERSECRETACCESSTOKENSECRET'
})

Defined Under Namespace

Classes: Request

Constant Summary

VALID_FORMATS =

[:json,:xml,:atom,:rss]

TWITTER_API_HOSTS =

Contains the mapping of API name symbols to actual host (and path) prefixes to use with requests. You can add your own to this hash and refer to it wherever Grackle::Client uses an API symbol. You may wish to do this when Twitter introduces API versions greater than 1.

{
  :search=>'search.twitter.com', :v1=>'api.twitter.com/1'
}

TWITTER_OAUTH_SPEC =

Basic OAuth information needed to communicate with Twitter

{
  :request_token_path=>'/oauth/request_token',
  :access_token_path=>'/oauth/access_token',
  :authorize_path=>'/oauth/authorize'
}

Instance Attribute Summary (collapse)

• - (Object) api

  Returns the value of attribute api.

• - (Object) api_hosts

  Returns the value of attribute api_hosts.

• - (Object) auth

  Returns the value of attribute auth.

• - (Object) auto_append_ids

  Returns the value of attribute auto_append_ids.

• - (Object) default_format

  Returns the value of attribute default_format.

• - (Object) handlers

  Returns the value of attribute handlers.

• - (Object) headers

  Returns the value of attribute headers.

• - (Object) request writeonly

  Sets the attribute request.

• - (Object) ssl

  Returns the value of attribute ssl.

• - (Object) timeout

  Returns the value of attribute timeout.

• - (Object) transport

  Returns the value of attribute transport.

Instance Method Summary (collapse)

• - (Object) [](api_name)

  Used to toggle APIs for a particular request without setting the Client's default API.

• - (Object) append(name, *args) (also: #_)
• - (Object) clear

  Clears any pending request built up by chained methods but not executed.

• - (Client) initialize(options = {}) constructor

  Arguments (all are optional):

  • :username - twitter username to authenticate with (deprecated in favor of :auth arg)

  • :password - twitter password to authenticate with (deprecated in favor of :auth arg)

  • :handlers - Hash of formats to Handler instances (e.g. :json=>CustomJSONHandler:json=>CustomJSONHandler.new)

  • :default_format - Symbol of format to use when no format is specified in an API call (e.g. :json, :xml)

  • :headers - Hash of string keys and values for headers to pass in the HTTP request to twitter

  • :ssl - true or false to turn SSL on or off.

• - (Object) method_missing(name, *args, &block)
• - (Object) password

  Deprecated in favor of using the auth attribute.

• - (Object) password=(value)

  Deprecated in favor of using the auth attribute.

• - (Object) username

  Deprecated in favor of using the auth attribute.

• - (Object) username=(value)

  Deprecated in favor of using the auth attribute.

114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

# File 'lib/grackle/client.rb', line 114

def initialize(options={})
  self.transport = Transport.new
  self.handlers = {:json=>Handlers::JSONHandler.new,:xml=>Handlers::XMLHandler.new,:unknown=>Handlers::StringHandler.new}
  self.handlers.merge!(options[:handlers]||{})
  self.default_format = options[:default_format] || :json 
  self.headers = {"User-Agent"=>"Grackle/#{Grackle::VERSION}"}.merge!(options[:headers]||{})
  self.ssl = options[:ssl] == true
  self.api = options[:api] || :v1
  self.api_hosts = TWITTER_API_HOSTS.clone
  self.timeout = options[:timeout] || 60
  self.auto_append_ids = options[:auto_append_ids] == false ? false : true
  self.auth = {}
  if options.has_key?(:username) || options.has_key?(:password)
    #Use basic auth if :username and :password args are passed in
    self.auth.merge!({:type=>:basic,:username=>options[:username],:password=>options[:password]})
  end
  #Handle auth mechanism that permits basic or oauth
  if options.has_key?(:auth)
    self.auth = options[:auth]
    if auth[:type] == :oauth
      self.auth = TWITTER_OAUTH_SPEC.merge(auth)
    end
  end
end

139
140
141
142
143
144

# File 'lib/grackle/client.rb', line 139

def method_missing(name,*args,&block)
  if block_given?
    return request_with_http_method_block(name,&block)
  end
  append(name,*args)
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def api
  @api
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def api_hosts
  @api_hosts
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def auth
  @auth
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def auto_append_ids
  @auto_append_ids
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def default_format
  @default_format
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def handlers
  @handlers
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def headers
  @headers
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def request=(value)
  @request = value
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def ssl
  @ssl
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def timeout
  @timeout
end

100
101
102

# File 'lib/grackle/client.rb', line 100

def transport
  @transport
end

client[:rest].users.show.hayesdavis?

148
149
150
151

# File 'lib/grackle/client.rb', line 148

def [](api_name)
  request.api = api_name
  self
end

188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

# File 'lib/grackle/client.rb', line 188

def append(name,*args)
  name = name.to_s.to_sym
  #The args will be a hash, store them if they're specified
  self.request.params = args.first
  #If method is a format name, execute using that format
  if format_invocation?(name)
    return call_with_format(name)
  end
  #If method ends in ! or ? use that to determine post or get
  if name.to_s =~ /^(.*)(!|\?)$/
    name = $1.to_sym
    #! is a post, ? is a get - only set this if the method hasn't been set
    self.request.method ||= ($2 == '!' ? :post : :get)          
    if format_invocation?(name)
      return call_with_format(name)
    else
      self.request << "/#{$1}"
      return call_with_format(self.default_format)
    end
  end
  #Else add to the request path
  self.request << "/#{name}"
  self
end

154
155
156

# File 'lib/grackle/client.rb', line 154

def clear
  self.request = nil
end

174
175
176
177
178

# File 'lib/grackle/client.rb', line 174

def password
  if auth[:type] == :basic
    auth[:password]
  end
end

181
182
183
184
185
186

# File 'lib/grackle/client.rb', line 181

def password=(value)
  unless auth[:type] == :basic
    auth[:type] = :basic
  end
  auth[:password] = value
end

159
160
161
162
163

# File 'lib/grackle/client.rb', line 159

def username
  if auth[:type] == :basic
    auth[:username]
  end
end

166
167
168
169
170
171

# File 'lib/grackle/client.rb', line 166

def username=(value)
  unless auth[:type] == :basic
    auth[:type] = :basic        
  end
  auth[:username] = value
end