api_client 0.1.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+bin
+coverage
+examples/config.rb
+*.sw[a-z]

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in fs-api.gemspec
+gemspec
+
+# Testing
+gem "rspec"
+gem "simplecov"
+
+# Soft dependencies
+gem "simple_oauth"
+gem 'multi_xml'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Marcin Bunsch
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,13 @@
+ApiClient
+=========
+
+ApiClient is an experimental builder for HTTP API clients. The goal is to provide a easy to use engine for constructing queries and map the responses to instances of Hashie::Mash subclasses.
+
+Basically you should be able to build a client for any HTTP based API, without the need for handling connections, parsing responses or instantiating objects. All you need to do is choose where the request should go and enhance your client classes. See the examples dir for usage examples.
+
+Current state is alpha - it works, but the query interface is not final and is subject to change at any time. Hell, even the can even change without prior notice. You were warned.
+
+Copyright
+---------
+
+Copyright (c) 2011 Marcin Bunsch, See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/api_client.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "api_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "api_client"
+  s.version     = ApiClient::VERSION
+  s.authors     = ["Marcin Bunsch"]
+  s.email       = ["marcin@futuresimple.com"]
+  s.homepage    = ""
+  s.summary     = %q{API client builder}
+  s.description = %q{API client builder}
+
+  s.rubyforge_project = "api_client"
+
+  s.add_dependency 'faraday', "=0.7.5"
+  s.add_dependency 'hashie',  "=1.2.0"
+  s.add_dependency 'yajl-ruby'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/examples/digg.rb

@@ -0,0 +1,31 @@
+require "rubygems"
+require "bundler/setup"
+require "api_client"
+
+module Digg
+
+  class Base < ApiClient::Base
+
+    always do
+      endpoint "http://services.digg.com"
+      params   :type => 'json'
+    end
+
+  end
+
+  class Collection < Base
+
+    def self.diggs
+      Digg.build get('/2.0/digg.getAll')['diggs']
+    end
+
+  end
+
+  class Digg < Base
+  end
+
+end
+
+Digg::Collection.diggs.each do |digg|
+  puts "#{digg.user.name}: #{digg.item.title}"
+end

data/examples/flickr.rb

@@ -0,0 +1,37 @@
+require "rubygems"
+require "bundler/setup"
+require "./examples/config" if File.exists?('examples/config.rb')
+require "api_client"
+
+module Flickr
+
+  class Base < ApiClient::Base
+    always do
+      endpoint "http://api.flickr.com"
+      params   :api_key => FLICKR_API_KEY,
+               :format => 'json',
+               :nojsoncallback => 1
+    end
+  end
+
+  class Collection < Base
+
+    def self.interesting
+      build params(:method => 'flickr.interestingness.getList').
+            get("/services/rest")
+    end
+
+    def photos
+      Photo.build self['photos']['photo']
+    end
+
+  end
+
+  class Photo < Base
+  end
+
+end
+
+Flickr::Collection.interesting.photos.each do |photo|
+  puts photo.title
+end

data/examples/github.rb

@@ -0,0 +1,52 @@
+require "rubygems"
+require "bundler/setup"
+require "./examples/config" if File.exists?('examples/config.rb')
+require "api_client"
+require "time"
+
+module Github
+
+  class Base < ApiClient::Base
+    namespace false
+
+    always do
+      endpoint "https://api.github.com"
+    end
+  end
+
+  class User < Base
+
+    def self.find(name)
+      fetch("/users/#{name}")
+    end
+
+    def events
+      Github::Event.fetch("/users/#{login}/events")
+    end
+
+    def received_events
+      Github::Event.fetch("/users/#{login}/received_events")
+    end
+
+  end
+
+  class Event < Base
+
+    def created_at
+      Time.parse self['created_at']
+    end
+
+  end
+
+end
+
+user = Github::User.find("marcinbunsch")
+
+user.events.each do |event|
+  case event.type
+    when "FollowEvent"
+      puts "#{event.created_at} #{event.payload.target.login}: #{event.type}"
+    else
+      puts "#{event.created_at} #{event.repo.name} : #{event.type}"
+    end
+end

data/examples/highrise.rb

@@ -0,0 +1,41 @@
+require "rubygems"
+require "bundler/setup"
+require "./examples/config" if File.exists?('examples/config.rb')
+require "api_client"
+require "multi_xml"
+
+module Highrise
+
+  class Base < ApiClient::Resource::Base
+    format      :xml
+
+    # In this hook we set the basic auth provided in the options
+    connection do |connection|
+      connection.handler.basic_auth connection.options[:user], connection.options[:pass]
+    end
+
+    always do
+      endpoint HIGHRISE_URL
+      options(:user => HIGHRISE_TOKEN, :pass => 'X')
+    end
+
+  end
+
+  class Person < Base
+    namespace false
+
+    always do
+      path "people"
+    end
+
+    def self.build_one(hash)
+      hash.has_key?('people') ? build_many(hash['people']) : super(hash)
+    end
+
+  end
+
+end
+
+Highrise::Person.find_all.each do |person|
+  puts "#{person.first_name} #{person.last_name}"
+end

data/examples/twitter.rb

@@ -0,0 +1,34 @@
+require "rubygems"
+require "bundler/setup"
+require "api_client"
+
+module Twitter
+
+  class Base < ApiClient::Base
+    always do
+      endpoint    "http://api.twitter.com/"
+    end
+  end
+
+  class Tweet < Base
+  end
+
+  class User < Base
+
+    def self.find_by_username(name)
+      params(:screen_name => name).fetch("/1/users/show.json")
+    end
+
+    def tweets
+      Tweet.params(:screen_name => self.screen_name).fetch("/1/statuses/user_timeline.json")
+    end
+
+  end
+
+end
+
+user = Twitter::User.find_by_username("marcinbunsch")
+puts user.name
+user.tweets.each do |tweet|
+  puts "  #{tweet.text}"
+end

data/examples/twitter_oauth.rb

@@ -0,0 +1,36 @@
+require "rubygems"
+require "bundler/setup"
+require "./examples/config" if File.exists?('examples/config.rb')
+require "api_client"
+
+module TwitterOauth
+
+  class Base < ApiClient::Base
+
+    always do
+      endpoint "https://api.twitter.com/"
+      adapter  :oauth
+
+      options  :oauth => {
+        :consumer_key => TWITTER_CONSUMER_KEY, :consumer_secret => TWITTER_CONSUMER_SECRET
+      }
+
+    end
+
+  end
+
+  class Tweet < Base
+
+    def self.tweet(message)
+      build post('/1/statuses/update.json', :status => message)
+    end
+
+  end
+
+end
+
+config = { :token => TWITTER_TOKEN, :token_secret => TWITTER_SECRET }
+
+message = TwitterOauth::Tweet.options(:oauth => config).tweet("test #{Time.now.to_i}")
+
+puts message.text

data/lib/api_client.rb

@@ -0,0 +1,45 @@
+require "api_client/version"
+module ApiClient
+  class << self
+    attr_accessor :logger
+  end
+
+  autoload :Base,          "api_client/base"
+  autoload :Errors,        "api_client/errors"
+  autoload :Scope,         "api_client/scope"
+  autoload :Utils,         "api_client/utils"
+
+  module Mixins
+    autoload :ConnectionHooks, "api_client/mixins/connection_hooks"
+    autoload :Delegation,      "api_client/mixins/delegation"
+    autoload :Configuration,   "api_client/mixins/configuration"
+    autoload :Inheritance,     "api_client/mixins/inheritance"
+    autoload :Instantiation,   "api_client/mixins/instantiation"
+    autoload :Scoping,         "api_client/mixins/scoping"
+  end
+
+  module Resource
+    autoload :Base,          "api_client/resource/base"
+    autoload :Scope,         "api_client/resource/scope"
+  end
+
+  module Connection
+
+    class << self
+      attr_accessor :default
+    end
+    self.default = :basic
+
+    module Middlewares
+      module Request
+        autoload :OAuth,  "api_client/connection/middlewares/request/oauth"
+        autoload :Logger, "api_client/connection/middlewares/request/logger"
+      end
+    end
+
+    autoload :Abstract, "api_client/connection/abstract"
+    autoload :Basic,    "api_client/connection/basic"
+    autoload :Oauth,    "api_client/connection/oauth"
+  end
+
+end

data/lib/api_client/base.rb

@@ -0,0 +1,52 @@
+require "hashie"
+require "yajl"
+
+module ApiClient
+
+  class Base < Hashie::Mash
+
+    extend ApiClient::Mixins::Inheritance
+    extend ApiClient::Mixins::Instantiation
+    extend ApiClient::Mixins::Scoping
+    extend ApiClient::Mixins::ConnectionHooks
+
+    class << self
+      extend ApiClient::Mixins::Delegation
+      extend ApiClient::Mixins::Configuration
+
+      delegate :fetch, :get, :put, :post, :delete, :headers, :endpoint, :options, :adapter, :params, :to => :scope
+
+      dsl_accessor :format, :namespace
+
+      def subkey_class
+        Hashie::Mash
+      end
+
+      def parse(response)
+        response = response.body if response.is_a?(Faraday::Response)
+        if self.format == :json
+          Yajl::Parser.parse(response)
+        elsif self.format == :xml
+          MultiXml.parse(response)
+        else
+          response
+        end
+      end
+
+    end
+
+    # Defaults
+    self.format :json
+
+    def id
+      self['id']
+    end
+
+    def inspect
+      "#<#{self.class} id: #{self.id}>"
+    end
+
+  end
+
+end
+

data/lib/api_client/connection/abstract.rb

@@ -0,0 +1,73 @@
+# Faraday for making requests
+require 'faraday'
+
+module ApiClient
+
+  module Connection
+
+    class Abstract
+
+      attr_accessor :endpoint, :handler, :options
+
+      def initialize(endpoint, options = {})
+        raise "Cannot instantiate abstract class" if self.class == ApiClient::Connection::Abstract
+        @endpoint = endpoint
+        @options  = options
+        create_handler
+      end
+
+      def create_handler
+      end
+
+      #### ApiClient::Connection::Abstract#get
+      # Performs a GET request
+      # Accepts three parameters:
+      #
+      # * path - the path the request should go to
+      # * data - (optional) the query, passed as a hash and converted into query params
+      # * headers - (optional) headers sent along with the request
+      #
+      def get(path, data = {}, headers = {})
+      end
+
+      #### ApiClient::Connection::Abstract#post
+      # Performs a POST request
+      # Accepts three parameters:
+      #
+      # * path - the path request should go to
+      # * data - (optional) data sent in the request
+      # * headers - (optional) headers sent along in the request
+      #
+      def post(path, data = {}, headers = {})
+      end
+
+      #### ApiClient::Connection::Abstract#put
+      # Performs a PUT request
+      # Accepts three parameters:
+      #
+      # * path - the path request should go to
+      # * data - (optional) data sent in the request
+      # * headers - (optional) headers sent along in the request
+      #
+      def put(path, data = {}, headers = {})
+      end
+
+      #### FS::Connection#delete
+      # Performs a DELETE request
+      # Accepts three parameters:
+      #
+      # * path - the path request should go to
+      # * data - (optional) the query, passed as a hash and converted into query params
+      # * headers - (optional) headers sent along in the request
+      #
+      def delete(path, data = {}, headers = {})
+      end
+
+      def inspect
+        "#<#{self.class} endpoint: \"#{endpoint}\">"
+      end
+      alias :to_s :inspect
+
+    end
+  end
+end