marcinbunsch-oauth_client 0.1.1 → 0.2.1

data/README.textile

@@ -2,25 +2,27 @@ h1. Generic OAuth Client for Ruby, based on moomerman/twitter_oauth
 
 *NOTE*: This is a very early version and has not been tested, give it some time :)
 
-This is a core OAuth Client, extracting core elements from the an awesome moomerman/twitter_oauth gem. This gem can be used to jump-start your new OAuth client.
+This is a core OAuth Client, extracting core elements from the an awesome moomerman/twitter_oauth gem and reorganizing them to give you tools to build your own client for an API of choice. This gem can be used to jump-start your new OAuth client.
 
 Example:
 <pre><code>require 'oauth_client'	
-class TwitterOAuth < OAuthClient
+class TwitterOAuth < OAuthClient::Client
   site 'http://twitter.com'
 end</code></pre>
 
-That's all you need to have a working OAuth client. Of course, it won't do anything just yet :) You need to implement specific methods for the API you're working with.
+That's all you need to have a working OAuth client which you can use to authorize with an OAuth server. Of course, it won't do anything just yet :) You need to implement specific methods for the API you're working with.
 
-You have a few helper methods to ease the trouble. OAuthClient#get and OAuthClient#post return the unparsed response from the server, whereas OAuthClient#get_json and OAuthClient#post_json parse JSON and return the result
+You have a few helper methods to ease the trouble. OAuthClient#get and OAuthClient#post return the unparsed response from the server. It includes an adapter for JSON, which will parse the response prior to returning it. To use it, call OAuthClient#json.get or OAuthClient#json.post.
 
 See this example from moomerman/twitter_oauth:
 <pre><code>module TwitterOauth
   class Client
+    [...]
     def user(page=1)
       oauth_response = access_token.get("/statuses/user_timeline.json?page=#{page}")
       JSON.parse(oauth_response.body)
     end
+		[...]
   end
 end
 </code></pre>
@@ -28,10 +30,17 @@ end
 with OAuthClient, it would look like this:
 
 <pre><code>require 'oauth_client'	
-class TwitterOAuth < OAuthClient
+class TwitterOAuth < OAuthClient::Client
   site 'http://twitter.com'
 
   def user(page=1)
-    get_json("/statuses/user_timeline.json?page=#{page}")
+    json.get("/statuses/user_timeline.json?page=#{page}")
   end
-end</code></pre>
+end</code></pre>
+
+h2. Authors
+
+This gem has been built by hacking and modifing the twitter_oauth gem by Richard Taylor (http://github.com/moomerman). The core client authorization structure is taken from there.
+
+Banged together by Marcin Bunsch (http://github.com/marcinbunsch).
+

data/lib/oauth_client.rb

@@ -1,80 +1,7 @@
 require 'rubygems'
 require 'oauth'
-require 'json'
+require 'oauth_client/client'
+require 'oauth_client/exceptions'
 
-class OAuthClient
-  
-  # base site
-  class << self
-    attr_accessor :site 
-  end  
-
-  def self.site(site = nil)
-    @site = site if site
-    @site
-  end
-  
-  def initialize(options = {})
-    @consumer_key = options[:consumer_key]
-    @consumer_secret = options[:consumer_secret]
-    @token = options[:token]
-    @secret = options[:secret]
-  end
-
-  # authorization
-  def authorize(token, secret)
-    request_token = OAuth::RequestToken.new(
-      consumer, token, secret
-    )
-    @access_token = request_token.get_access_token
-    @token = @access_token.token
-    @secret = @access_token.secret
-    @access_token
-  end
-  
-  def authentication_request_token
-    consumer.options[:authorize_path] = '/oauth/authenticate'
-    request_token
-  end
-  
-  def request_token
-    consumer.get_request_token
-  end
-  
-  # request helpers
-  def get(url)
-    raise OAuthUnauthorized if !access_token
-    access_token.get(url)
-  end
-  
-  def post(url, params = {})
-    raise OAuthUnauthorized if !access_token
-    access_token.post(url, params)
-  end
-  
-  def get_json(url)
-    oauth_response = get(url)
-    JSON.parse(oauth_response.body)
-  end
-  
-  def post_json(url, params = {})
-    oauth_response = get(url, params)
-    JSON.parse(oauth_response.body)
-  end
-  
-  private
-    def consumer
-      @consumer ||= OAuth::Consumer.new(
-        @consumer_key,
-        @consumer_secret,
-        { :site=> self.class.site }
-      )
-    end
-
-    def access_token
-      @access_token ||= OAuth::AccessToken.new(consumer, @token, @secret)
-    end
-end
-
-class OAuthUnauthorized < Exception
+module OAuthClient
 end

data/lib/oauth_client/adapters/json.rb

@@ -0,0 +1,26 @@
+require 'json'
+module OAuthClient
+  module Adapters
+    # Json Adapter for OAuthClient
+    class Json
+      attr_accessor :client
+  
+      # on creation, the adapter must be supplied with the client
+      def initialize(client)
+        self.client = client
+      end
+  
+      # make a GET request and parse JSON response
+      def get(url)
+        oauth_response = self.client.get(url)
+        JSON.parse(oauth_response.body)
+      end
+  
+      # make a GET request and parse JSON response
+      def post(url, params = {})
+        oauth_response = self.client.post(url, params)
+        JSON.parse(oauth_response.body)
+      end
+    end
+  end
+end

data/lib/oauth_client/client.rb

@@ -0,0 +1,77 @@
+module OAuthClient
+  class Client
+  
+    # base uri for the API
+    class << self
+      attr_accessor :site 
+    end  
+  
+    # class method for setting/getting the base uri for API
+    def self.site(site = nil)
+      @site = site if site
+      @site
+    end
+  
+    # constructor
+    def initialize(options = {})
+      @consumer_key = options[:consumer_key]
+      @consumer_secret = options[:consumer_secret]
+      @token = options[:token]
+      @secret = options[:secret]
+      @adapters = {}
+    end
+
+    # authorization
+    def authorize(token, secret)
+      request_token = OAuth::RequestToken.new(
+        consumer, token, secret
+      )
+      @access_token = request_token.get_access_token
+      @token = @access_token.token
+      @secret = @access_token.secret
+      @access_token
+    end
+  
+    # get the request token
+    def request_token
+      consumer.get_request_token
+    end
+    
+    # make a GET request and return raw response
+    def get(url)
+      raise OAuthUnauthorized if !access_token
+      access_token.get(url)
+    end
+  
+    # make a POST request and return raw response
+    def post(url, params = {})
+      raise OAuthUnauthorized if !access_token
+      access_token.post(url, params)
+    end
+  
+    # json adapter, allowing json.get and json.post methods
+    def json
+      return @adapters[:json] if @adapters[:json]
+      require 'oauth_client/adapters/json'
+      @adapters[:json] = OAuthClient::Adapters::Json.new(self)
+    end
+  
+    private
+  
+      # get the consumer object, with site specified by class variable
+      def consumer
+        @consumer ||= OAuth::Consumer.new(
+          @consumer_key,
+          @consumer_secret,
+          { :site=> self.class.site }
+        )
+      end
+
+      # get access token used for API access
+      def access_token
+        @access_token ||= OAuth::AccessToken.new(consumer, @token, @secret)
+      end
+
+  end
+
+end

data/lib/oauth_client/exceptions.rb

@@ -0,0 +1,5 @@
+module OAuthClient
+  module Exceptions 
+    class OAuthUnauthorized < Exception; end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marcinbunsch-oauth_client
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Marcin Bunsch, Richard Taylor
@@ -43,7 +43,10 @@ extra_rdoc_files: []
 files: 
 - README.textile
 - lib/oauth_client.rb
-has_rdoc: false
+- lib/oauth_client/client.rb
+- lib/oauth_client/exceptions.rb
+- lib/oauth_client/adapters/json.rb
+has_rdoc: true
 homepage: http://github.com/marcinbunsch/oauth_client
 post_install_message: 
 rdoc_options: