oahu 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oahu.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Oahu
+
+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,29 @@
+# Oahu
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'oahu'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install oahu
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/oahu.rb

@@ -0,0 +1,26 @@
+require 'oahu/core_ext/hash'
+require 'oahu/client'
+require 'oahu/config'
+
+module Oahu
+  extend Config
+  class << self
+    # Alias for Oahu::Client.new
+    #
+    # @return [Oahu::Client]
+    def new(options={})
+      Oahu::Client.new(options)
+    end
+
+    # Delegate to Oahu::Client
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+
+end

data/lib/oahu/client.rb

@@ -0,0 +1,33 @@
+require 'oahu/config'
+require 'oahu/connection'
+require 'oahu/request'
+
+module Oahu
+  class Client
+
+    attr_accessor *Config::VALID_OPTIONS_KEYS
+
+    include Oahu::Connection
+    include Oahu::Request
+
+    # Initializes a new API object
+    #
+    # @param attrs [Hash]
+    # @return [Oahu::Client]
+    def initialize(attrs={})
+      attrs = Oahu.options.merge(attrs)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+
+    def credentials
+      {
+        :client_id        => client_id,
+        :consumer_id      => consumer_id,
+        :consumer_secret  => consumer_secret
+      }
+    end
+    
+  end
+end

data/lib/oahu/config.rb

@@ -0,0 +1,85 @@
+require 'oahu/version'
+
+module Oahu
+  # Defines constants and methods related to configuration
+  module Config
+
+    # The HTTP connection adapter that will be used to connect if none is set
+    DEFAULT_ADAPTER = :net_http
+
+    # The Faraday connection options if none is set
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+
+    # The client ID if none is set
+    DEFAULT_CLIENT_ID = nil
+
+    # The consumer ID if none is set
+    DEFAULT_CONSUMER_ID = nil
+
+    # The consumer secret if none is set
+    DEFAULT_CONSUMER_SECRET = nil
+
+    # The endpoint that will be used to connect if none is set
+    #
+    DEFAULT_ENDPOINT = 'https://app.oahu.fr'
+
+    # The oauth token if none is set
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # The oauth token secret if none is set
+    DEFAULT_OAUTH_TOKEN_SECRET = nil
+
+    DEFAULT_CACHE_STORE = nil
+
+    
+    # The value sent in the 'User-Agent' header if none is set
+    DEFAULT_USER_AGENT = "Oahu Ruby Gem #{Oahu::VERSION}"
+
+    # An array of valid keys in the options hash when configuring a {Oahu::Client}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :connection_options,
+      :client_id, 
+      :consumer_id,
+      :consumer_secret,
+      :endpoint,
+      :user_agent,
+      :cache_store
+    ]
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+      self
+    end
+
+    # Create a hash of options and their values
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{|k| options[k] = send(k)}
+      options
+    end
+
+    # Reset all configuration options to defaults
+    def reset
+      self.adapter            = DEFAULT_ADAPTER
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.client_id          = DEFAULT_CLIENT_ID
+      self.consumer_id        = DEFAULT_CONSUMER_ID
+      self.consumer_secret    = DEFAULT_CONSUMER_SECRET
+      self.endpoint           = DEFAULT_ENDPOINT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.cache_store        = DEFAULT_CACHE_STORE
+      self
+    end
+
+  end
+end

data/lib/oahu/connection.rb

@@ -0,0 +1,31 @@
+require 'faraday'
+require 'oahu/request/auth'
+require 'faraday_middleware/response/parse_json'
+require 'faraday_middleware/response/caching'
+
+module Oahu
+  module Connection
+  private
+
+    # Returns a Faraday::Connection object
+    #
+    # @param options [Hash] A hash of options
+    # @return [Faraday::Connection]
+    def connection(options={})
+      default_options = {
+        :headers => {
+          :accept => 'application/json',
+          :user_agent => user_agent,
+        },
+        :ssl => {:verify => false},
+        :url => options.fetch(:endpoint, endpoint),
+      }
+      @connection ||= Faraday.new(default_options.deep_merge(connection_options)) do |builder|
+        builder.use Oahu::Request::Auth, credentials
+        builder.use FaradayMiddleware::Caching, cache_store unless cache_store.nil?
+        builder.use FaradayMiddleware::ParseJson
+        builder.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/oahu/core_ext/hash.rb

@@ -0,0 +1,19 @@
+class Hash
+
+  # Merges self with another hash, recursively
+  #
+  # @param hash [Hash] The hash to merge
+  # @return [Hash]
+  def deep_merge(hash)
+    target = self.dup
+    hash.keys.each do |key|
+      if hash[key].is_a?(Hash) && self[key].is_a?(Hash)
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+      target[key] = hash[key]
+    end
+    target
+  end
+
+end

data/lib/oahu/request.rb

@@ -0,0 +1,42 @@
+module Oahu
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP DELETE request
+    def delete(path, params={}, options={})
+      request(:delete, api_path(path), params, options)
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={}, options={})
+      request(:get, api_path(path), params, options)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={}, options={})
+      request(:post, api_path(path), params, options)
+    end
+
+  private
+
+    def api_path path
+      "/api/v1/clients/#{credentials[:client_id]}/#{path.gsub(/^\//, '')}"
+    end
+
+    # Perform an HTTP request
+    def request(method, path, params, options)
+      response = connection(options).run_request(method, nil, nil, nil) do |request|
+        # request.options[:phoenix] = true if options[:phoenix]
+        request.options[:raw] = true if options[:raw]
+        case method.to_sym
+        when :delete, :get
+          request.url(path, params)
+        when :post
+          request.path = path
+          request.body = params unless params.empty?
+        end
+      end
+      options[:raw] ? response : response.body
+    end
+
+  end
+end

data/lib/oahu/request/auth.rb

@@ -0,0 +1,21 @@
+require 'digest/md5'
+
+module Oahu
+  module Request
+    class Auth  < Faraday::Middleware
+
+      def call(env)
+        sig_time   = Time.now.to_i
+        signature  = Digest::MD5.hexdigest [sig_time, @credentials[:client_id], @credentials[:consumer_secret]].join("-")
+        env[:request_headers]['Oahu-Consumer-Id']   = @credentials[:consumer_id]
+        env[:request_headers]['Oahu-Consumer-Sig']  = [sig_time, @credentials[:client_id], signature].join("|")
+        @app.call(env)
+      end
+
+      def initialize(app, credentials)
+        @app, @credentials = app, credentials
+      end
+
+    end
+  end
+end

data/lib/oahu/version.rb

@@ -0,0 +1,3 @@
+module Oahu
+  VERSION = "0.0.1"
+end

data/oahu.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/oahu/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Stephane Bellity", "Oahu"]
+  gem.email         = ["sbellity@gmail.com"]
+  gem.description   = %q{Oahu API Ruby Client}
+  gem.summary       = %q{Oahu API Ruby Client}
+  gem.homepage      = "http://oahu.fr"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "oahu"
+  gem.require_paths = ["lib"]
+  gem.version       = Oahu::VERSION
+
+  # Dependencies
+  gem.add_dependency 'faraday',               '~> 0.7'
+  gem.add_dependency 'faraday_middleware',    '~> 0.7'
+  gem.add_dependency 'multi_json',            '~> 1.0'
+
+  # Development Dependencies
+  gem.add_development_dependency 'activesupport',         ['>= 2.3.9', '< 4']
+  gem.add_development_dependency 'redis-activesupport', '~> 3.2.3'
+
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: oahu
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Stephane Bellity
+- Oahu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70327220899760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70327220899760
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: &70327220899260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70327220899260
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70327220898780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70327220898780
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70327220914480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.3.9
+    - - <
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: *70327220914480
+- !ruby/object:Gem::Dependency
+  name: redis-activesupport
+  requirement: &70327220911800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.3
+  type: :development
+  prerelease: false
+  version_requirements: *70327220911800
+description: Oahu API Ruby Client
+email:
+- sbellity@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/oahu.rb
+- lib/oahu/client.rb
+- lib/oahu/config.rb
+- lib/oahu/connection.rb
+- lib/oahu/core_ext/hash.rb
+- lib/oahu/request.rb
+- lib/oahu/request/auth.rb
+- lib/oahu/version.rb
+- oahu.gemspec
+homepage: http://oahu.fr
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Oahu API Ruby Client
+test_files: []