oauth-client 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+
+*.gem
+*.gemspec

data/README.textile

@@ -0,0 +1,46 @@
+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 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::Client
+  site 'http://twitter.com'
+end</code></pre>
+
+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. 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>
+
+with OAuthClient, it would look like this:
+
+<pre><code>require 'oauth_client'	
+class TwitterOAuth < OAuthClient::Client
+  site 'http://twitter.com'
+
+  def user(page=1)
+    json.get("/statuses/user_timeline.json?page=#{page}")
+  end
+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/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "oauth-client"
+    gem.summary = %q{Generic OAuth Client for Ruby, based on moomerman/twitter_oauth}
+    gem.description = %q{Generic OAuth Client for Ruby, based on moomerman/twitter_oauth}
+    gem.email = "marcel@northdocks.com"
+    gem.homepage = "http://github.com/sirlantis/oauth-client"
+    gem.authors = ["Marcin Bunch, Marcel Jackwerth, Richard Taylor"]
+    
+    gem.add_dependency('oauth', '>= 0.3.1')
+    gem.add_dependency('json', '>= 1.1.2')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/demos/tripit_oauth.rb

@@ -0,0 +1,15 @@
+# This is a Tripit API client demo built on top of OAuthClient
+require 'oauth_client'
+class TripitOAuth < OAuthClient::Client
+  site 'https://api.tripit.com'
+
+  def info
+    json.get('/v1/get/profile?format=json')
+  end
+ 
+  def trips
+    json.get('/v1/list/trip/traveler/true?format=json')
+  end
+
+end
+

data/demos/twitter_oauth.rb

@@ -0,0 +1,23 @@
+# This is a Twitter API client demo built on top of OAuthClient
+require 'oauth_client'
+class TwitterOAuth < OAuthClient::Client
+  site 'http://twitter.com'
+  
+  def show(username)
+    json.get("/users/show/#{username}.json")
+  end
+
+  def friends(username)
+    json.get("/friends/ids/#{username}.json")
+  end
+  
+  def user(page=1)
+    json.get("/statuses/user_timeline.json?page=#{page}")
+  end
+  
+  def update(message)
+    json.post('/statuses/update.json', :status => message)
+  end
+ 
+end
+

data/lib/oauth_client.rb

@@ -0,0 +1,9 @@
+
+$:.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'oauth'
+require 'oauth_client/client'
+require 'oauth_client/exceptions'
+
+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/adapters/xml.rb

@@ -0,0 +1,26 @@
+require 'nokogiri'
+module OAuthClient
+  module Adapters
+    # Xml Adapter for OAuthClient
+    class Xml
+      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 Xml response
+      def get(url)
+        oauth_response = self.client.get(url)
+        Nokogiri::XML::Document.parse(oauth_response.body)
+      end
+  
+      # make a GET request and parse Xml response
+      def post(url, params = {})
+        oauth_response = self.client.post(url, params)
+        Nokogiri::XML::Document.parse(oauth_response.body)
+      end
+    end
+  end
+end

data/lib/oauth_client/client.rb

@@ -0,0 +1,110 @@
+module OAuthClient
+  class Client
+
+    # class method for setting/getting the base uri for API
+    def self.site(site = nil)
+      @@site = site if site
+      @@site
+    end
+
+    # class method for setting/getting the http method for API
+    def self.http_method(http_method = nil)
+      @@http_method = http_method if http_method
+      @@http_method
+    end
+
+    # class method for setting/getting the http method for API
+    def self.scheme(scheme = nil)
+      @@scheme = scheme if scheme
+      @@scheme
+    end
+
+    def self.request_scheme(scheme = nil)
+      @@request_scheme = scheme if scheme
+      @@request_scheme
+    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, options = {})
+      request_token = OAuth::RequestToken.new(
+        consumer, token, secret
+      )
+      @access_token = request_token.get_access_token(options)
+      @token = @access_token.token
+      @secret = @access_token.secret
+      @access_token
+    end
+  
+    # get the request token
+    def request_token(options = {})
+      consumer(:scheme => (@@request_scheme || :header)).get_request_token(options)
+    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
+
+    # xml adapter, allowing xml.get and xml.post methods
+    def xml
+      return @adapters[:xml] if @adapters[:xml]
+      require 'oauth_client/adapters/xml'
+      @adapters[:xml] = OAuthClient::Adapters::Xml.new(self)
+    end
+  
+    private
+  
+    # get the consumer object, with site specified by class variable
+    def consumer(options = nil)
+      if @consumer and !options
+        return @consumer
+      end
+
+      consumer_options = {
+        :site=> @@site,
+        :http_method => @@http_method || :post,
+        :scheme => @@scheme || :header
+      }
+      consumer_options.merge(options) if options
+
+      consumer = OAuth::Consumer.new(
+        @consumer_key,
+        @consumer_secret,
+        consumer_options
+      )
+
+      @consumer = consumer unless options
+      consumer
+    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

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: oauth-client
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Marcin Bunch, Marcel Jackwerth, Richard Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+description: Generic OAuth Client for Ruby, based on moomerman/twitter_oauth
+email: marcel@northdocks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+files: 
+- .gitignore
+- README.textile
+- Rakefile
+- VERSION
+- demos/tripit_oauth.rb
+- demos/twitter_oauth.rb
+- lib/oauth_client.rb
+- lib/oauth_client/adapters/json.rb
+- lib/oauth_client/adapters/xml.rb
+- lib/oauth_client/client.rb
+- lib/oauth_client/exceptions.rb
+has_rdoc: true
+homepage: http://github.com/sirlantis/oauth-client
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Generic OAuth Client for Ruby, based on moomerman/twitter_oauth
+test_files: []
+