hackeroo 0.1.0

data/lib/hackeroo/core_ext/enumerable.rb

@@ -0,0 +1,10 @@
+module Enumerable
+
+  def threaded_map
+    threads = map do |object|
+      Thread.new { yield object }
+    end
+    threads.map(&:value)
+  end
+
+end

data/lib/hackeroo/core_ext/kernel.rb

@@ -0,0 +1,6 @@
+module Kernel
+
+  # Returns the object's singleton class (exists in Ruby 1.9.2)
+  def singleton_class; class << self; self; end; end unless method_defined?(:singleton_class)
+
+end

data/lib/hackeroo/cursor.rb

@@ -0,0 +1,87 @@
+require 'hackeroo/core_ext/kernel'
+
+module Hackeroo
+  class Cursor
+    include Enumerable
+    attr_reader :attrs, :collection
+    alias to_hash attrs
+
+    # Initializes a new Cursor object
+    #
+    # @param response [Hash]
+    # @param collection_name [String, Symbol] The name of the method to return the collection
+    # @param klass [Class] The class to instantiate object in the collection
+    # @param client [Hackeroo::Client]
+    # @param method_name [String, Symbol]
+    # @param method_options [Hash]
+    # @return [Hackeroo::Cursor]
+    def self.from_response(response, collection_name, klass, client, method_name, method_options)
+      new(response[:body], collection_name, klass, client, method_name, method_options)
+    end
+
+    # Initializes a new Cursor
+    #
+    # @param attrs [Hash]
+    # @param collection_name [String, Symbol] The name of the method to return the collection
+    # @param klass [Class] The class to instantiate object in the collection
+    # @param client [Hackeroo::Client]
+    # @param method_name [String, Symbol]
+    # @param method_options [Hash]
+    # @return [Hackeroo::Cursor]
+    def initialize(attrs, collection_name, klass, client, method_name, method_options)
+      @attrs = attrs
+      @client = client
+      @method_name = method_name
+      @method_options = method_options
+      @collection = Array(attrs[collection_name.to_sym]).map do |item|
+        if klass
+          klass.fetch_or_new(item)
+        else
+          item
+        end
+      end
+      singleton_class.class_eval do
+        alias_method(collection_name.to_sym, :collection)
+      end
+    end
+
+    # @param collection [Array]
+    # @param cursor [Integer]
+    # @return [Array]
+    def all(collection=collection, cursor=next_cursor)
+      cursor = @client.send(@method_name.to_sym, @method_options.merge(:cursor => cursor))
+      collection += cursor.collection
+      cursor.last? ? collection.flatten : all(collection, cursor.next_cursor)
+    end
+
+    # @return [Enumerable]
+    def each
+      all(collection, next_cursor).each do |element|
+        yield element
+      end
+    end
+
+    def next_cursor
+      @attrs[:next_cursor] || -1
+    end
+    alias next next_cursor
+
+    def previous_cursor
+      @attrs[:previous_cursor]
+    end
+    alias previous previous_cursor
+
+    # @return [Boolean]
+    def first?
+      previous_cursor.zero?
+    end
+    alias first first?
+
+    # @return [Boolean]
+    def last?
+      next_cursor.zero?
+    end
+    alias last last?
+
+  end
+end

data/lib/hackeroo/default.rb

@@ -0,0 +1,77 @@
+require 'faraday'
+require 'faraday/request/multipart'
+require 'hackeroo/configurable'
+require 'hackeroo/error/client_error'
+require 'hackeroo/error/server_error'
+require 'hackeroo/response/parse_json'
+require 'hackeroo/response/raise_error'
+require 'hackeroo/version'
+
+module Hackeroo
+  module Default
+    ENDPOINT = 'http://api.hackeroo.io' unless defined? Hackeroo::Default::ENDPOINT
+    CONNECTION_OPTIONS = {
+      :headers => {
+        :accept => 'application/json',
+        :user_agent => "Hackeroo Ruby Gem #{Hackeroo::Version}",
+      },
+      :request => {
+        :open_timeout => 5,
+        :timeout => 10,
+      },
+    } unless defined? Hackeroo::Default::CONNECTION_OPTIONS
+    IDENTITY_MAP = false unless defined? Hackeroo::Default::IDENTITY_MAP
+    MIDDLEWARE = Faraday::Builder.new do |builder|
+      # Convert request params to "www-form-urlencoded"
+      builder.use Faraday::Request::UrlEncoded
+      # Handle 4xx server responses
+      builder.use Hackeroo::Response::RaiseError, Hackeroo::Error::ClientError
+      # Parse JSON response bodies using MultiJson
+      builder.use Hackeroo::Response::ParseJson
+      # Handle 5xx server responses
+      builder.use Hackeroo::Response::RaiseError, Hackeroo::Error::ServerError
+      # Set Faraday's HTTP adapter
+      builder.adapter Faraday.default_adapter
+    end unless defined? Hackeroo::Default::MIDDLEWARE
+
+    class << self
+
+      # @return [Hash]
+      def options
+        Hash[Hackeroo::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # @return [String]
+      def clientkey
+        ENV['HACKEROO_CLIENTKEY']
+      end
+
+      # @note This is configurable in case you want to use a Hackeroo-compatible endpoint.
+      # @see http://status.net/wiki/Hackeroo-compatible_API
+      # @see http://en.blog.wordpress.com/2009/12/12/hackeroo-api/
+      # @see http://staff.tumblr.com/post/287703110/api
+      # @see http://developer.typepad.com/typepad-hackeroo-api/hackeroo-api.html
+      # @return [String]
+      def endpoint
+        ENDPOINT
+      end
+
+      def connection_options
+        CONNECTION_OPTIONS
+      end
+
+      def identity_map
+        IDENTITY_MAP
+      end
+
+      # @note Faraday's middleware stack implementation is comparable to that of Rack middleware.  The order of middleware is important: the first middleware on the list wraps all others, while the last middleware is the innermost one.
+      # @see https://github.com/technoweenie/faraday#advanced-middleware-usage
+      # @see http://mislav.uniqpath.com/2011/07/faraday-advanced-http/
+      # @return [Faraday::Builder]
+      def middleware
+        MIDDLEWARE
+      end
+
+    end
+  end
+end

data/lib/hackeroo/error.rb

@@ -0,0 +1,32 @@
+module Hackeroo
+  # Custom error class for rescuing from all Hackeroo errors
+  class Error < StandardError
+    attr_reader :rate_limit, :wrapped_exception
+
+    # @return [Hash]
+    def self.errors
+      @errors ||= Hash[descendants.map{|klass| [klass.const_get(:HTTP_STATUS_CODE), klass]}]
+    end
+
+    # @return [Array]
+    def self.descendants
+      ObjectSpace.each_object(::Class).select{|klass| klass < self}
+    end
+
+    # Initializes a new Error object
+    #
+    # @param exception [Exception, String]
+    # @param response_headers [Hash]
+    # @return [Hackeroo::Error]
+    def initialize(exception=$!, response_headers={})
+      @rate_limit = Hackeroo::RateLimit.new(response_headers)
+      @wrapped_exception = exception
+      exception.respond_to?(:backtrace) ? super(exception.message) : super(exception.to_s)
+    end
+
+    def backtrace
+      @wrapped_exception.respond_to?(:backtrace) ? @wrapped_exception.backtrace : super
+    end
+
+  end
+end

data/lib/hackeroo/error/bad_gateway.rb

@@ -0,0 +1,11 @@
+require 'hackeroo/error/server_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 502
+    class BadGateway < Hackeroo::Error::ServerError
+      HTTP_STATUS_CODE = 502
+      MESSAGE = "Hackeroo is down or being upgraded."
+    end
+  end
+end

data/lib/hackeroo/error/bad_request.rb

@@ -0,0 +1,10 @@
+require 'hackeroo/error/client_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 400
+    class BadRequest < Hackeroo::Error::ClientError
+      HTTP_STATUS_CODE = 400
+    end
+  end
+end

data/lib/hackeroo/error/client_error.rb

@@ -0,0 +1,35 @@
+require 'hackeroo/error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns a 4xx HTTP status code or there's an error in Faraday
+    class ClientError < Hackeroo::Error
+
+      # Create a new error from an HTTP environment
+      #
+      # @param response [Hash]
+      # @return [Hackeroo::Error]
+      def self.from_response(response={})
+        new(parse_error(response[:body]), response[:response_headers])
+      end
+
+    private
+
+      def self.parse_error(body)
+        if body.nil?
+          ''
+        elsif body[:error]
+          body[:error]
+        elsif body[:errors]
+          first = Array(body[:errors]).first
+          if first.is_a?(Hash)
+            first[:message].chomp
+          else
+            first.chomp
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/hackeroo/error/configuration_error.rb

@@ -0,0 +1,8 @@
+require 'hackeroo/error'
+
+module Hackeroo
+  class Error
+    class ConfigurationError < ::ArgumentError
+    end
+  end
+end

data/lib/hackeroo/error/decode_error.rb

@@ -0,0 +1,9 @@
+require 'hackeroo/error'
+
+module Hackeroo
+  class Error
+    # Raised when JSON parsing fails
+    class DecodeError < Hackeroo::Error
+    end
+  end
+end

data/lib/hackeroo/error/forbidden.rb

@@ -0,0 +1,10 @@
+require 'hackeroo/error/client_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 403
+    class Forbidden < Hackeroo::Error::ClientError
+      HTTP_STATUS_CODE = 403
+    end
+  end
+end

data/lib/hackeroo/error/gateway_timeout.rb

@@ -0,0 +1,11 @@
+require 'hackeroo/error/server_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 504
+    class GatewayTimeout < Hackeroo::Error::ServerError
+      HTTP_STATUS_CODE = 504
+      MESSAGE = "The Hackeroo servers are up, but the request couldn't be serviced due to some failure within our stack. Try again later."
+    end
+  end
+end

data/lib/hackeroo/error/identity_map_key_error.rb

@@ -0,0 +1,9 @@
+require 'hackeroo/error'
+
+module Hackeroo
+  class Error
+    # Inherit from KeyError when Ruby 1.8 compatibility is removed
+    class IdentityMapKeyError < ::IndexError
+    end
+  end
+end

data/lib/hackeroo/error/internal_server_error.rb

@@ -0,0 +1,11 @@
+require 'hackeroo/error/server_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 500
+    class InternalServerError < Hackeroo::Error::ServerError
+      HTTP_STATUS_CODE = 500
+      MESSAGE = "Something is technically wrong."
+    end
+  end
+end

data/lib/hackeroo/error/not_acceptable.rb

@@ -0,0 +1,10 @@
+require 'hackeroo/error/client_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 406
+    class NotAcceptable < Hackeroo::Error::ClientError
+      HTTP_STATUS_CODE = 406
+    end
+  end
+end

data/lib/hackeroo/error/not_found.rb

@@ -0,0 +1,10 @@
+require 'hackeroo/error/client_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 404
+    class NotFound < Hackeroo::Error::ClientError
+      HTTP_STATUS_CODE = 404
+    end
+  end
+end

data/lib/hackeroo/error/server_error.rb

@@ -0,0 +1,28 @@
+require 'hackeroo/error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns a 5xx HTTP status code
+    class ServerError < Hackeroo::Error
+      MESSAGE = "Server Error"
+
+      # Create a new error from an HTTP environment
+      #
+      # @param response [Hash]
+      # @return [Hackeroo::Error]
+      def self.from_response(response={})
+        new(nil, response[:response_headers])
+      end
+
+      # Initializes a new ServerError object
+      #
+      # @param message [String]
+      # @param response_headers [Hash]
+      # @return [Hackeroo::Error::ServerError]
+      def initialize(message=nil, response_headers={})
+        super((message || self.class.const_get(:MESSAGE)), response_headers)
+      end
+
+    end
+  end
+end

data/lib/hackeroo/error/service_unavailable.rb

@@ -0,0 +1,11 @@
+require 'hackeroo/error/server_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 503
+    class ServiceUnavailable < Hackeroo::Error::ServerError
+      HTTP_STATUS_CODE = 503
+      MESSAGE = "(__-){ Hackeroo is over capacity."
+    end
+  end
+end

data/lib/hackeroo/error/too_many_requests.rb

@@ -0,0 +1,12 @@
+require 'hackeroo/error/client_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 429
+    class TooManyRequests < Hackeroo::Error::ClientError
+      HTTP_STATUS_CODE = 429
+    end
+    EnhanceYourCalm = TooManyRequests
+    RateLimited = TooManyRequests
+  end
+end

data/lib/hackeroo/error/unauthorized.rb

@@ -0,0 +1,10 @@
+require 'hackeroo/error/client_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 401
+    class Unauthorized < Hackeroo::Error::ClientError
+      HTTP_STATUS_CODE = 401
+    end
+  end
+end

data/lib/hackeroo/error/unprocessable_entity.rb

@@ -0,0 +1,10 @@
+require 'hackeroo/error/client_error'
+
+module Hackeroo
+  class Error
+    # Raised when Hackeroo returns the HTTP status code 404
+    class UnprocessableEntity < Hackeroo::Error::ClientError
+      HTTP_STATUS_CODE = 422
+    end
+  end
+end