angellist_api 0.0.1

data/lib/angellist_api/configuration.rb

@@ -0,0 +1,90 @@
+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,
+      :consumer_key,
+      :consumer_secret,
+      :endpoint,
+      :format,
+      :gateway,
+      :oauth_token,
+      :oauth_token_secret,
+      :proxy,
+      :user_agent,
+      :media_endpoint,
+      :faraday_options].freeze
+
+    # The adapter that will be used to connect if none is set
+    DEFAULT_ADAPTER = :net_http
+
+    # 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 = 'https://api.angel.co/1'.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 value sent in the 'User-Agent' header if none is set
+    DEFAULT_USER_AGENT = "AngellistApi Ruby Gem #{AngellistApi::VERSION}".freeze
+
+    DEFAULT_GATEWAY = nil
+
+    DEFAULT_FARADAY_OPTIONS = {}.freeze
+
+    # @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.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.user_agent         = DEFAULT_USER_AGENT
+      self.gateway            = DEFAULT_GATEWAY
+      self.faraday_options    = DEFAULT_FARADAY_OPTIONS
+      self
+    end
+  end
+end

data/lib/angellist_api/connection.rb

@@ -0,0 +1,48 @@
+require 'faraday_middleware'
+require 'faraday/request/phoenix'
+require 'faraday/request/multipart_with_file'
+require 'faraday/request/gateway'
+require 'faraday/request/twitter_oauth'
+require 'faraday/response/raise_http_4xx'
+require 'faraday/response/raise_http_5xx'
+
+module AngellistApi
+  # @private
+  module Connection
+    private
+
+    def connection(options={})
+      merged_options = faraday_options.merge({
+        :headers => {
+          'Accept' => "application/#{format}",
+          '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?
+        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.adapter(adapter)
+      end
+    end
+  end
+end

data/lib/angellist_api/error.rb

@@ -0,0 +1,59 @@
+module AngellistApi
+  # Custom error class for rescuing from all AngellistApi 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 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/request.rb

@@ -0,0 +1,43 @@
+module AngellistApi
+  # Defines HTTP request methods
+  module Request
+    # Perform an HTTP GET request
+    def get(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    def post(path, params={}, options={})
+      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|
+        case method.to_sym
+        when :get, :delete
+          request.url(formatted_path(path, options), params)
+        when :post, :put
+          request.path = formatted_path(path, options)
+          request.body = params unless params.empty?
+        end
+      end
+      options[:raw] ? response : response.body
+    end
+
+    def formatted_path(path, options={})
+      [path, options.fetch(:format, format)].compact.join('.')
+    end
+  end
+end

data/lib/angellist_api/version.rb

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

data/lib/tasks/angellist_api_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :angellist_api do
+#   # Task goes here
+# end

data/test/angellist_api_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AngellistApiTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, AngellistApi
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "angellist_api"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,27 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+end