evrythng 0.0.1

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/evrythng.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'evrythng/version'
+
+Gem::Specification.new do |s|
+  s.name         = "evrythng"
+  s.version      = Evrythng::VERSION.dup
+  s.authors      = ["beawesomeinstead"]
+  s.email        = "graf.otodrakula@gmail.com"
+  s.homepage     = "http://github.com/bai/evrythng"
+  s.summary      = "A Ruby wrapper for the Evrythng API."
+  s.description  = "A Ruby wrapper for the Evrythng API."
+
+  s.files        = `git ls-files`.split("\n")
+  s.platform     = Gem::Platform::RUBY
+  s.require_path = 'lib'
+
+  s.add_development_dependency('yard', '~> 0.6')
+
+  s.add_runtime_dependency 'hashie', '~> 1.0.0'
+  s.add_runtime_dependency 'faraday', '~> 0.6.1'
+  s.add_runtime_dependency 'faraday_middleware', '~> 0.6.3'
+  s.add_runtime_dependency 'multi_json', '~> 1.0.0'
+  s.add_runtime_dependency 'multi_xml', '~> 0.2.0'
+  s.add_runtime_dependency 'rash', '~> 0.3.0'
+  s.add_runtime_dependency 'simple_oauth', '~> 0.1.5'
+end

data/lib/evrythng/api.rb

@@ -0,0 +1,23 @@
+require 'evrythng/connection'
+require 'evrythng/request'
+require 'evrythng/authentication'
+
+module Evrythng
+  # @private
+  class API
+    # @private
+    attr_accessor *Configuration::VALID_OPTIONS_KEYS
+
+    # Creates a new API
+    def initialize(options={})
+      options = Evrythng.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    include Connection
+    include Request
+    include Authentication
+  end
+end

data/lib/evrythng/authentication.rb

@@ -0,0 +1,25 @@
+module Evrythng
+  # @private
+  module Authentication
+    private
+
+    # Authentication hash
+    #
+    # @return [Hash]
+    def authentication
+      {
+        :consumer_key => consumer_key,
+        :consumer_secret => consumer_secret,
+        :token => oauth_token,
+        :token_secret => oauth_token_secret
+      }
+    end
+
+    # Check whether user is authenticated
+    #
+    # @return [Boolean]
+    def authenticated?
+      authentication.values.all?
+    end
+  end
+end

data/lib/evrythng/client/collections.rb

@@ -0,0 +1,21 @@
+module Evrythng
+  class Client
+    # Defines methods related to collections
+    module Collections
+      # Returns a list of collections
+      #
+      # @format :json, :xml
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @return [Hashie::Rash] The requested list of collections.
+      # @see http://dev.evrythng.net/doc/get/collections
+      # @example Return the list of collections
+      #   Evrythng.collections
+      def collections(options={})
+        response = get('collections', options)
+        format.to_s.downcase == 'xml' ? response['collections'] : response
+      end
+    end
+  end
+end

data/lib/evrythng/client/things.rb

@@ -0,0 +1,21 @@
+module Evrythng
+  class Client
+    # Defines methods related to things
+    module Things
+      # Returns a list of things
+      #
+      # @format :json, :xml
+      # @authenticated true
+      # @rate_limited true
+      # @param options [Hash] A customizable set of options.
+      # @return [Hashie::Rash] The requested list of things.
+      # @see http://dev.evrythng.net/doc/get/things
+      # @example Return the list of things
+      #   Evrythng.things
+      def things(options={})
+        response = get('things', options)
+        format.to_s.downcase == 'xml' ? response['things'] : response
+      end
+    end
+  end
+end

data/lib/evrythng/client.rb

@@ -0,0 +1,13 @@
+module Evrythng
+  # Wrapper for the Evrythng REST API
+  class Client < API
+    # Require client method modules after initializing the Client class in
+    # order to avoid a superclass mismatch error, allowing those modules to be
+    # Client-namespaced.
+    require 'evrythng/client/things'
+    require 'evrythng/client/collections'
+
+    include Evrythng::Client::Things
+    include Evrythng::Client::Collections
+  end
+end

data/lib/evrythng/configuration.rb

@@ -0,0 +1,100 @@
+require 'faraday'
+require 'evrythng/version'
+
+module Evrythng
+  # Defines constants and methods related to configuration
+  module Configuration
+    # An array of valid keys in the options hash when configuring a {Evrythng::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :consumer_key,
+      :consumer_secret,
+      :api_endpoint,
+      :format,
+      :gateway,
+      :oauth_token,
+      :oauth_token_secret,
+      :proxy,
+      :search_endpoint,
+      :user_agent].freeze
+
+    # An array of valid request/response formats
+    #
+    # @note Not all methods support the XML format.
+    VALID_FORMATS = [
+      :json,
+      :xml].freeze
+
+    # The adapter that will be used to connect if none is set
+    #
+    # @note The default faraday adapter is Net::HTTP.
+    DEFAULT_ADAPTER = Faraday.default_adapter
+
+    # By default, don't set an application key
+    DEFAULT_CONSUMER_KEY = nil
+
+    # By default, don't set an application secret
+    DEFAULT_CONSUMER_SECRET = nil
+
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = 'http://evrythng.net/api/v1/'.freeze
+
+    # The response format appended to the path and sent in the 'Accept' header if none is set
+    #
+    # @note JSON is preferred over XML because it is more concise and faster to parse.
+    DEFAULT_FORMAT = :json
+
+    # By default, don't set a user oauth token
+    DEFAULT_OAUTH_TOKEN = nil
+
+    # By default, don't set a user oauth secret
+    DEFAULT_OAUTH_TOKEN_SECRET = nil
+
+    # By default, don't use a proxy server
+    DEFAULT_PROXY = nil
+
+    # The search endpoint that will be used to connect if none is set
+    DEFAULT_SEARCH_ENDPOINT = 'http://evrythng.net/api/v1/search'.freeze
+
+    # The user agent that will be sent to the API endpoint if none is set
+    DEFAULT_USER_AGENT = "Evrythng Ruby Gem #{Evrythng::VERSION}".freeze
+
+    DEFAULT_GATEWAY = nil
+
+    # @private
+    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
+    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.consumer_key       = DEFAULT_CONSUMER_KEY
+      self.consumer_secret    = DEFAULT_CONSUMER_SECRET
+      self.api_endpoint       = DEFAULT_ENDPOINT
+      self.format             = DEFAULT_FORMAT
+      self.oauth_token        = DEFAULT_OAUTH_TOKEN
+      self.oauth_token_secret = DEFAULT_OAUTH_TOKEN_SECRET
+      self.proxy              = DEFAULT_PROXY
+      self.search_endpoint    = DEFAULT_SEARCH_ENDPOINT
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.gateway            = DEFAULT_GATEWAY
+      self
+    end
+  end
+end

data/lib/evrythng/connection.rb

@@ -0,0 +1,42 @@
+require 'faraday_middleware'
+require 'faraday/request/multipart_with_file'
+require 'faraday/request/gateway'
+require 'faraday/request/evrythng_oauth'
+require 'faraday/response/raise_http_4xx'
+require 'faraday/response/raise_http_5xx'
+
+module Evrythng
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+      options = {
+        :headers => {'Accept' => "application/#{format}", 'User-Agent' => user_agent},
+        :proxy => proxy,
+        :ssl => {:verify => false},
+        :url => api_endpoint,
+      }
+
+      Faraday.new(options) do |builder|
+        builder.use Faraday::Request::MultipartWithFile
+        builder.use Faraday::Request::EvrythngOAuth, authentication if authenticated?
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Request::Gateway, gateway if gateway
+        builder.use Faraday::Response::RaiseHttp4xx
+        builder.use Faraday::Response::Rashify unless raw
+        unless raw
+          case format.to_s.downcase
+          when 'json'
+            builder.use Faraday::Response::ParseJson
+          when 'xml'
+            builder.use Faraday::Response::ParseXml
+          end
+        end
+        builder.use Faraday::Response::RaiseHttp5xx
+        builder.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/evrythng/error.rb

@@ -0,0 +1,59 @@
+module Evrythng
+  # Custom error class for rescuing from all Evrythng errors
+  class Error < StandardError
+    attr_reader :http_headers
+
+    def initialize(message, http_headers)
+      @http_headers = Hash[http_headers]
+      super message
+    end
+
+    def ratelimit_reset
+      Time.at(@http_headers.values_at('x-ratelimit-reset', 'X-RateLimit-Reset').detect{|value| value}.to_i)
+    end
+
+    def ratelimit_limit
+      @http_headers.values_at('x-ratelimit-limit', 'X-RateLimit-Limit').detect{|value| value}.to_i
+    end
+
+    def ratelimit_remaining
+      @http_headers.values_at('x-ratelimit-remaining', 'X-RateLimit-Remaining').detect{|value| value}.to_i
+    end
+
+    def retry_after
+      [(ratelimit_reset - Time.now).ceil, 0].max
+    end
+  end
+
+  # Raised when Evrythng returns the HTTP status code 400
+  class BadRequest < Error; end
+
+  # Raised when Evrythng returns the HTTP status code 401
+  class Unauthorized < Error; end
+
+  # Raised when Evrythng returns the HTTP status code 403
+  class Forbidden < Error; end
+
+  # Raised when Evrythng returns the HTTP status code 404
+  class NotFound < Error; end
+
+  # Raised when Evrythng returns the HTTP status code 406
+  class NotAcceptable < Error; end
+
+  # Raised when Evrythng returns the HTTP status code 420
+  class EnhanceYourCalm < Error
+    # The number of seconds your application should wait before requesting date from the Search API again
+    def retry_after
+      @http_headers.values_at('retry-after', 'Retry-After').detect {|value| value }.to_i
+    end
+  end
+
+  # Raised when Evrythng returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+  # Raised when Evrythng returns the HTTP status code 502
+  class BadGateway < Error; end
+
+  # Raised when Evrythng returns the HTTP status code 503
+  class ServiceUnavailable < Error; end
+end

data/lib/evrythng/request.rb

@@ -0,0 +1,44 @@
+module Evrythng
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, options={}, raw=false)
+      request(:get, path, options, raw)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, options={}, raw=false)
+      request(:post, path, options, raw)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, options={}, raw=false)
+      request(:put, path, options, raw)
+    end
+
+    # Perform an HTTP DELETE request
+    def delete(path, options={}, raw=false)
+      request(:delete, path, options, raw)
+    end
+
+    private
+
+    # Perform an HTTP request
+    def request(method, path, options, raw=false)
+      response = connection(raw).send(method) do |request|
+        case method
+        when :get, :delete
+          request.url(formatted_path(path), options)
+        when :post, :put
+          request.path = formatted_path(path)
+          request.body = options unless options.empty?
+        end
+      end
+      raw ? response : response.body
+    end
+
+    def formatted_path(path)
+      [path, format].compact.join('.')
+    end
+  end
+end

data/lib/evrythng/version.rb

@@ -0,0 +1,4 @@
+module Evrythng
+  # The version of the gem
+  VERSION = '0.0.1'.freeze unless defined?(::Evrythng::VERSION)
+end

data/lib/evrythng.rb

@@ -0,0 +1,25 @@
+require 'evrythng/error'
+require 'evrythng/configuration'
+require 'evrythng/api'
+require 'evrythng/client'
+
+module Evrythng
+  extend Configuration
+
+  # Alias for Evrythng::Client.new
+  #
+  # @return [Evrythng::Client]
+  def self.new(options={})
+    Evrythng::Client.new(options)
+  end
+
+  # Delegate to Evrythng::Client
+  def self.method_missing(method, *args, &block)
+    return super unless new.respond_to?(method)
+    new.send(method, *args, &block)
+  end
+
+  def self.respond_to?(method, include_private = false)
+    new.respond_to?(method, include_private) || super(method, include_private)
+  end
+end

data/lib/faraday/request/evrythng_oauth.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+module Faraday
+  class Request::EvrythngOAuth < Faraday::Middleware
+    dependency 'simple_oauth'
+
+    def call(env)
+      params = env[:body] || {}
+      signature_params = params
+
+      params.map{ |k,v| signature_params = {} if v.respond_to?(:content_type) }
+
+      header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
+
+      env[:request_headers]['Authorization'] = header.to_s
+
+      @app.call(env)
+    end
+
+    def initialize(app, options)
+      @app, @options = app, options
+    end
+  end
+end

data/lib/faraday/request/gateway.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Request::Gateway < Faraday::Middleware
+    def call(env)
+      url = env[:url].dup
+      url.host = @gateway
+      env[:url] = url
+      @app.call(env)
+    end
+
+    def initialize(app, gateway)
+      @app, @gateway = app, gateway
+    end
+  end
+end

data/lib/faraday/request/multipart_with_file.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Request::MultipartWithFile < Faraday::Middleware
+    def call(env)
+      if env[:body].is_a?(Hash)
+        env[:body].each do |key, value|
+          if value.is_a?(File)
+            env[:body][key] = Faraday::UploadIO.new(value, mime_type(value), value.path)
+          end
+        end
+      end
+
+      @app.call(env)
+    end
+
+    private
+
+    def mime_type(file)
+      case file.path
+        when /\.jpe?g/i then 'image/jpeg'
+        when /\.gif$/i then 'image/gif'
+        when /\.png$/i then 'image/png'
+        else 'application/octet-stream'
+      end
+    end
+  end
+end

data/lib/faraday/request/oauth.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+module Faraday
+  class Request::OAuth < Faraday::Middleware
+    dependency 'simple_oauth'
+
+    def call(env)
+      params = env[:body] || {}
+      signature_params = params
+
+      params.map{ |k,v| signature_params = {} if v.respond_to?(:content_type) }
+
+      header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
+
+      env[:request_headers]['Authorization'] = header.to_s
+
+      @app.call(env)
+    end
+
+    def initialize(app, options)
+      @app, @options = app, options
+    end
+  end
+end

data/lib/faraday/response/raise_http_4xx.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp4xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 400
+        raise Evrythng::BadRequest.new(error_message(env), env[:response_headers])
+      when 401
+        raise Evrythng::Unauthorized.new(error_message(env), env[:response_headers])
+      when 403
+        raise Evrythng::Forbidden.new(error_message(env), env[:response_headers])
+      when 404
+        raise Evrythng::NotFound.new(error_message(env), env[:response_headers])
+      when 406
+        raise Evrythng::NotAcceptable.new(error_message(env), env[:response_headers])
+      when 420
+        raise Evrythng::EnhanceYourCalm.new(error_message(env), env[:response_headers])
+      end
+    end
+
+    private
+
+    def error_message(env)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{env[:status]}#{error_body(env[:body])}"
+    end
+
+    def error_body(body)
+      if body.nil?
+        nil
+      elsif body['error']
+        ": #{body['error']}"
+      elsif body['errors']
+        first = Array(body['errors']).first
+        if first.kind_of? Hash
+          ": #{first['message'].chomp}"
+        else
+          ": #{first.chomp}"
+        end
+      end
+    end
+  end
+end

data/lib/faraday/response/raise_http_5xx.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+# @private
+module Faraday
+  # @private
+  class Response::RaiseHttp5xx < Response::Middleware
+    def on_complete(env)
+      case env[:status].to_i
+      when 500
+        raise Evrythng::InternalServerError.new(error_message(env, "Something is technically wrong."), env[:response_headers])
+      when 502
+        raise Evrythng::BadGateway.new(error_message(env, "Evrythng is down or being upgraded."), env[:response_headers])
+      when 503
+        raise Evrythng::ServiceUnavailable.new(error_message(env, "(__-){ Evrythng is over capacity."), env[:response_headers])
+      end
+    end
+
+    private
+
+    def error_message(env, body=nil)
+      "#{env[:method].to_s.upcase} #{env[:url].to_s}: #{[env[:status].to_s + ':', body].compact.join(' ')} Check http://status.evrythng.net/ for updates on the status of the Evrythng service."
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification 
+name: evrythng
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- beawesomeinstead
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: faraday_middleware
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.3
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: multi_xml
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rash
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: simple_oauth
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.1.5
+  type: :runtime
+  version_requirements: *id008
+description: A Ruby wrapper for the Evrythng API.
+email: graf.otodrakula@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- evrythng.gemspec
+- lib/evrythng.rb
+- lib/evrythng/api.rb
+- lib/evrythng/authentication.rb
+- lib/evrythng/client.rb
+- lib/evrythng/client/collections.rb
+- lib/evrythng/client/things.rb
+- lib/evrythng/configuration.rb
+- lib/evrythng/connection.rb
+- lib/evrythng/error.rb
+- lib/evrythng/request.rb
+- lib/evrythng/version.rb
+- lib/faraday/request/evrythng_oauth.rb
+- lib/faraday/request/gateway.rb
+- lib/faraday/request/multipart_with_file.rb
+- lib/faraday/request/oauth.rb
+- lib/faraday/response/raise_http_4xx.rb
+- lib/faraday/response/raise_http_5xx.rb
+homepage: http://github.com/bai/evrythng
+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.5
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the Evrythng API.
+test_files: []
+