sayso-api-client 0.1.0 → 0.1.1

data/README.rdoc

@@ -17,6 +17,10 @@ Use the gem.
 
   gem install sayso-api-client
 
+Use in your Gemfile:
+
+  gem 'sayso-api-client', :require => 'sayso'
+
 == Usage
 
   require 'sayso'

data/lib/sayso.rb

@@ -3,34 +3,47 @@ require 'crack'
 require 'active_support/all'
 #
 # Example usage:
-#  sayso = Sayso.new(:consumer_key => 'your_key', :consumer_secret => 'your_secret')
+#  sayso = Sayso.new(:consumer_key => 'your_key', :consumer_secret => 'your_secret', :callback = 'http://localhost:3000')
 #  sayso.get("/places/search?what=restaurant&where=antwerpen")
 #  sayso.get("/places/search", :what => 'restaurant', :where => 'antwerpen')
 #  sayso.authorize_url # go here (=> "http://api.sayso.com/api1/oauth/authorize?oauth_token=some_token_hash")
 #  sayso.authorize_access_token('verifier')
+#  sayso.get_params # => 
 #  sayso.get("/users/current")
+#  sayso.get('/places/cj5C4oyiCr3Ra2aby-7U4a/reviews')
+#  review = '<?xml version="1.0" encoding="UTF-8"?><review><rating>2</rating><text>This is my review number 1. It is not so long but states that it works. We can see that everything is ok.</text></review>'
+#  sayso.post('/places/cj5C4oyiCr3Ra2aby-7U4a/reviews', review)
 #
 class Sayso
 
-  attr_accessor :version, :consumer_key, :consumer_secret, :base_url, :callback
+  attr_accessor :version, :consumer_key, :consumer_secret, :base_url, :callback, :get_params
   attr_reader :access_token, :request_token, :response
 
+  # Example:
+  #  Sayso.new(:consumer_key => 'your_key', :consumer_secret => 'your_secret', :language => 'nl-NL')
+  # The language parameter is optional.
   def initialize(options = {})
     options = {:version => 1, :base_url => 'http://api.sayso.com', :callback => nil}.merge(options)
+
+    # The language options is set to the get_params.
+    @get_params = {}
+    @get_params[:language] = options.delete(:language) if options[:language]
+
+    # All other options should be set to the related instance variable.
     options.each do |attr, value|
       instance_variable_set(:"@#{attr}", value)
     end
     self.initialize_access_token
   end
 
-  def initialize_access_token
-    return @access_token unless @access_token.nil?
+  def initialize_access_token(force = false)
+    return @access_token if force || @access_token.nil?
     @consumer = OAuth::Consumer.new(self.consumer_key, self.consumer_secret, {
       :site => self.base_url,
       :request_token_path => "/api#{self.version}/oauth/request_token",
       :authorize_path => "/api#{self.version}/oauth/authorize",
       :access_token_path => "/api#{self.version}/oauth/access_token" })
-    @request_token = @consumer.get_request_token(:oauth_callback => "http://localhost:3000")
+    @request_token = @consumer.get_request_token(:oauth_callback => callback)
     # Just make it using the request token (and a user that has given access ?!)
     @access_token = OAuth::AccessToken.new(@consumer, @request_token.token, @request_token.secret)
   end
@@ -53,6 +66,7 @@ class Sayso
   # Access the unparsed response using the response method.
   # Examples:
   #  get("/places/search?what=restaurant&where=antwerpen")
+  #  get("/places/search", :what => 'restaurant', :where => 'antwerpen', :base_country => 'BE')
   def get(path, params = {})
     path = "/api#{self.version}#{path}"
     path += "?#{params.to_query}" unless params.blank?
@@ -61,8 +75,13 @@ class Sayso
     HashWithIndifferentAccess.new(result)
   end
 
-  # TODO
-  # def post/put
-  # end
+  # Examples:
+  #  post('/places/:place_id/reviews', :rating => 3, :text => "My review text that should be a certain length.")
+  def post(path, params = {})
+    path = "/api#{self.version}#{path}"
+    @response = @access_token.post(path, params, { 'Accept'=>'application/xml', 'Content-Type' => 'application/xml' })
+    result = Crack::XML.parse(@response.body)
+    HashWithIndifferentAccess.new(result)
+  end
 
 end

data/sayso-api-client.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = %q{sayso-api-client}
-  spec.version = '0.1.0'
+  spec.version = '0.1.1'
   spec.platform = Gem::Platform::RUBY
   spec.description = spec.summary = 'Ruby gem to use the SaySo API (v1).'
   spec.authors = ['Joost Hietbrink']

metadata

@@ -2,7 +2,7 @@
 name: sayso-api-client
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Joost Hietbrink
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-21 00:00:00 +02:00
+date: 2011-07-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency