angellist_api 1.0.1 → 1.0.2

data/lib/angellist_api/configuration.rb

@@ -3,42 +3,38 @@ require 'angellist_api/version'
 module AngellistApi
   # Defines constants and methods related to configuration
   module Configuration
-    # An array of valid keys in the options hash when configuring a {AngellistApi::API}
-    VALID_OPTIONS_KEYS = [
-      :adapter,
-      :endpoint,
-      :format,
-      :gateway,
-      :access_token,
-      :proxy,
-      :user_agent,
-      :faraday_options].freeze
+    # The access token if none is set
+    DEFAULT_ACCESS_TOKEN = nil
 
-    # The adapter that will be used to connect if none is set
+    # The HTTP connection adapter that will be used to connect if none is set
     DEFAULT_ADAPTER = :net_http
 
-    # The endpoint that will be used to connect if none is set
-    DEFAULT_ENDPOINT = "https://api.angel.co/".freeze
+    # The Faraday connection options if none are set
+    DEFAULT_CONNECTION_OPTIONS = {}
 
-    # 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
+    # The endpoint that will be used to connect if none is set
+    DEFAULT_ENDPOINT = "https://api.angel.co/"
 
-    # By default, don't set a user oauth access token
-    DEFAULT_ACCESS_TOKEN = nil
+    # The gateway server if none is set
+    DEFAULT_GATEWAY = nil
 
-    # By default, don't use a proxy server
+    # The proxy server if none is set
     DEFAULT_PROXY = nil
 
     # The value sent in the 'User-Agent' header if none is set
-    DEFAULT_USER_AGENT = "AngellistApi Ruby Gem #{AngellistApi::VERSION}".freeze
+    DEFAULT_USER_AGENT = "AngellistApi Ruby Gem #{AngellistApi::VERSION}"
 
-    DEFAULT_GATEWAY = nil
-
-    DEFAULT_FARADAY_OPTIONS = {}.freeze
+    # An array of valid keys in the options hash when configuring a {AngellistApi::API}
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :connection_options,
+      :endpoint,
+      :gateway,
+      :access_token,
+      :proxy,
+      :user_agent
+    ]
 
-    # @private
     attr_accessor *VALID_OPTIONS_KEYS
 
     # When this module is extended, set all configuration options to their default values
@@ -60,14 +56,13 @@ module AngellistApi
 
     # Reset all configuration options to defaults
     def reset
+      self.access_token       = DEFAULT_ACCESS_TOKEN
       self.adapter            = DEFAULT_ADAPTER
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
       self.endpoint           = DEFAULT_ENDPOINT
-      self.format             = DEFAULT_FORMAT
-      self.access_token       = DEFAULT_ACCESS_TOKEN
+      self.gateway            = DEFAULT_GATEWAY
       self.proxy              = DEFAULT_PROXY
       self.user_agent         = DEFAULT_USER_AGENT
-      self.gateway            = DEFAULT_GATEWAY
-      self.faraday_options    = DEFAULT_FARADAY_OPTIONS
       self
     end
   end

data/lib/angellist_api/connection.rb

@@ -1,48 +1,46 @@
+require 'faraday'
 require 'faraday_middleware'
-require 'faraday/request/phoenix'
-require 'faraday/request/multipart_with_file'
-require 'faraday/request/gateway'
-require 'faraday/request/angellist_api_oauth'
-require 'faraday/response/raise_http_4xx'
-require 'faraday/response/raise_http_5xx'
+require 'angellist_api/core_ext/hash'
+require 'angellist_api/request/multipart_with_file'
+require 'angellist_api/request/gateway'
+require 'angellist_api/request/angellist_api_oauth'
+require 'angellist_api/response/raise_client_error'
+require 'angellist_api/response/raise_server_error'
 
 module AngellistApi
-  # @private
   module Connection
     private
 
+    # Returns a Faraday::Connection object
+    #
+    # @param options [Hash] A hash of options
+    # @return [Faraday::Connection]
     def connection(options={})
-      merged_options = faraday_options.merge({
+      default_options = {
         :headers => {
-          'Accept' => "application/#{format}",
-          'User-Agent' => user_agent
+          :accept => 'application/json',
+          :user_agent => user_agent
         },
         :proxy => proxy,
         :ssl => {:verify => false},
         :url => options.fetch(:endpoint, api_endpoint)
-      })
-      
-      Faraday.new(merged_options) do |builder|
-        builder.use Faraday::Request::Phoenix if options[:phoenix]
-        builder.use Faraday::Request::MultipartWithFile
-        builder.use Faraday::Request::AngellistApiOAuth, authentication if authenticated?
+      }
+
+      @connection ||= Faraday.new(connection_options.deep_merge(default_options)) do |builder|
+        builder.use AngellistApi::Request::MultipartWithFile
+        builder.use AngellistApi::Request::AngellistApiOAuth, 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
-        unless options[:raw]
-          case options.fetch(:format, format).to_s.downcase
-          when 'json', 'phoenix'
-            builder.use Faraday::Response::Mashify
-            builder.use Faraday::Response::ParseJson
-          when 'xml'
-            builder.use Faraday::Response::Mashify
-            builder.use Faraday::Response::ParseXml
-          end
-        end
-        builder.use Faraday::Response::RaiseHttp5xx
+        builder.use AngellistApi::Request::Gateway, gateway if gateway
+        builder.use AngellistApi::Response::RaiseClientError
+        builder.use Faraday::Response::Mashify
+        builder.use Faraday::Response::ParseJson
+        builder.use AngellistApi::Response::RaiseServerError
         builder.adapter(adapter)
       end
+
+      @connection
     end
   end
 end
+

data/lib/angellist_api/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/angellist_api/error.rb

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

data/lib/angellist_api/error/bad_gateway.rb

@@ -0,0 +1,7 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 502
+  class Error::BadGateway < AngellistApi::Error; end
+end
+

data/lib/angellist_api/error/bad_request.rb

@@ -0,0 +1,7 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 400
+  class Error::BadRequest < AngellistApi::Error; end
+end
+

data/lib/angellist_api/error/enhance_your_calm.rb

@@ -0,0 +1,13 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 420
+  class Error::EnhanceYourCalm < AngellistApi::Error
+    # The number of seconds your application should wait before requesting date
+    # from the API again
+    def retry_after
+      @http_headers.values_at('retry-after', 'Retry-After').detect {|value| value }.to_i
+    end
+  end
+end
+

data/lib/angellist_api/error/forbidden.rb

@@ -0,0 +1,7 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 403
+  class Error::Forbidden < AngellistApi::Error; end
+end
+

data/lib/angellist_api/error/internal_server_error.rb

@@ -0,0 +1,7 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 500
+  class Error::InternalServerError < AngellistApi::Error; end
+end
+

data/lib/angellist_api/error/not_acceptable.rb

@@ -0,0 +1,7 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 406
+  class Error::NotAcceptable < AngellistApi::Error; end
+end
+

data/lib/angellist_api/error/not_found.rb

@@ -0,0 +1,7 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 404
+  class Error::NotFound < AngellistApi::Error; end
+end
+

data/lib/angellist_api/error/service_unavailable.rb

@@ -0,0 +1,7 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 503
+  class Error::ServiceUnavailable < AngellistApi::Error; end
+end
+

data/lib/angellist_api/error/unauthorized.rb

@@ -0,0 +1,7 @@
+require 'angellist_api/error'
+
+module AngellistApi
+  # Raised when AngellistApi returns the HTTP status code 401
+  class Error::Unauthorized < AngellistApi::Error; end
+end
+

data/lib/angellist_api/request.rb

@@ -1,6 +1,11 @@
 module AngellistApi
   # Defines HTTP request methods
   module Request
+    # Perform an HTTP DELETE request
+    def delete(path, params={}, options={})
+      request(:delete, path, params, options)
+    end
+
     # Perform an HTTP GET request
     def get(path, params={}, options={})
       request(:get, path, params, options)
@@ -10,34 +15,22 @@ module AngellistApi
       request(:post, path, params, options)
     end
 
-    # Perform an HTTP PUT request
-    def put(path, params={}, options={})
-      request(:put, path, params, options)
-    end
-
-    # Perform an HTTP DELETE request
-    def delete(path, params={}, options={})
-      request(:delete, path, params, options)
-    end
-
     private
 
     # Perform an HTTP request
     def request(method, path, params, options)
-      response = connection(options).send(method) do |request|
+      response = connection(options).run_request(method, nil, nil, nil) do |request|
+        request.options[:raw] = true if options[:raw]
         case method.to_sym
-        when :get, :delete
-          request.url(formatted_path(path, options), params)
-        when :post, :put
-          request.path = formatted_path(path, options)
+        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
 
-    def formatted_path(path, options={})
-      path
-    end
   end
 end

data/lib/angellist_api/request/angellist_api_oauth.rb

@@ -0,0 +1,16 @@
+require 'faraday'
+
+module AngellistApi
+  module Request
+    class AngellistApiOAuth < Faraday::Middleware
+      def call(env)
+        env[:request_headers]['Authorization'] = "Bearer #{@options[:access_token]}" if @options[:access_token]
+        @app.call(env)
+      end
+
+      def initialize(app, options)
+        @app, @options = app, options
+      end
+    end
+  end
+end

data/lib/angellist_api/request/gateway.rb

@@ -0,0 +1,18 @@
+require 'faraday'
+
+module AngellistApi
+  module Request
+    class 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
+end

data/lib/angellist_api/request/multipart_with_file.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+
+module AngellistApi
+  module Request
+    class 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.path), value.path)
+            elsif value.is_a?(Hash) && (value['io'].is_a?(IO) || value['io'].is_a?(StringIO))
+              env[:body][key] = Faraday::UploadIO.new(value['io'], mime_type('.'+value['type']), '')
+            end
+          end
+        end
+
+        @app.call(env)
+      end
+
+      private
+
+      def mime_type(path)
+        case path
+        when /\.jpe?g/i
+          'image/jpeg'
+        when /\.gif$/i
+          'image/gif'
+        when /\.png$/i
+          'image/png'
+        else
+          'application/octet-stream'
+        end
+      end
+    end
+  end
+end