angellist_api 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= AngellistApi
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AngellistApi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/angellist_api.rb

@@ -0,0 +1,28 @@
+require 'angellist_api/api'
+require 'angellist_api/base'
+require 'angellist_api/client'
+require 'angellist_api/configuration'
+require 'angellist_api/error'
+require 'angellist_api/search'
+
+module AngellistApi
+  extend Configuration
+  class << self
+    # Alias for AngellistApi::Client.new
+    #
+    # @return [AngellistApi::Client]
+    def new(options={})
+      AngellistApi::Client.new(options)
+    end
+
+    # Delegate to AngellistApi::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/angellist_api/api.rb

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

data/lib/angellist_api/authentication.rb

@@ -0,0 +1,25 @@
+module AngellistApi
+  # @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/angellist_api/client.rb

@@ -0,0 +1,27 @@
+module AngellistApi
+  # Wrapper for the AngellistApi REST API
+  #
+  # @note All methods have been separated into modules and follow the same grouping used in {http://angel.co/api the Angellist API Documentation}.
+  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 'angellist_api/client/follows'
+    require 'angellist_api/client/reviews'
+    require 'angellist_api/client/startups'
+    require 'angellist_api/client/startup_roles'
+    require 'angellist_api/client/status_updates'
+    require 'angellist_api/client/tags'
+    require 'angellist_api/client/users'
+
+    alias :api_endpoint :endpoint
+
+    include AngellistApi::Client::Follows
+    include AngellistApi::Client::Reviews
+    include AngellistApi::Client::Startups
+    include AngellistApi::Client::StartupRoles
+    include AngellistApi::Client::StatusUpdates
+    include AngellistApi::Client::Tags
+    include AngellistApi::Client::Users
+  end
+end

data/lib/angellist_api/client/follows.rb

@@ -0,0 +1,96 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    module Follows
+      # Makes the authenticated user follow the specified item. Returns the new follow on success, or an error on failure.
+      # @requires_authentication Yes
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :type Must be either user or startup. 
+      # @option options [Integer] :id The id of the user or startup to start following.
+      # @example Makes the authenticated user follow the specified item. Returns the new follow on success, or an error on failure.
+      #   AngellistApi.new_follow
+      def new_follow(options={})
+        post("/follows", options, :format => :json, :phoenix => true)
+      end
+      
+      # Makes the authenticated user stop following the specified item. Returns the deleted follow on success, or an error on failure.
+      # @requires_authentication Yes
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :type Must be either user or startup. 
+      # @option options [Integer] :id The id of the user or startup to start following.
+      # @example Makes the authenticated user stop following the specified item. Returns the deleted follow on success, or an error on failure.
+      #   AngellistApi.delete_follow
+      def delete_follow(options={})
+        delete("/follows", options, :format => :json, :phoenix => true)
+      end
+      
+      # Return the given user's followers, paginated and ordered by most recent follower first.
+      # @requires_authentication No
+      # @response_format `json`
+      # @param options [Integer] The id of the given user.
+      # @example Return the given user's followers, paginated and ordered by most recent follower first.
+      #   AngellistApi.get_user_followers
+      def get_user_followers(id)
+        get("/users/#{id}/followers", :format => :json, :phoenix => true)
+      end
+      
+      # Return the ids of the given user's followers, paginated and ordered by most recent follower first.
+      # @requires_authentication No
+      # @response_format `json`
+      # @param options [Integer] The id of the given user.
+      # @example Return the ids of the given user's followers, paginated and ordered by most recent follower first.
+      #   AngellistApi.get_user_follower_ids
+      def get_user_follower_ids(id)
+        get("/users/#{id}/followers/ids", :format => :json, :phoenix => true)
+      end
+      
+      # Return objects that the given user is following, paginated and ordered by most recent follow first. See the type parameter to specify which class of objects to return.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param id [Integer] The id of the given user.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :type Must be either user or startup. 
+      # @example Return objects that the given user is following, paginated and ordered by most recent follow first. See the type parameter to specify which class of objects to return.
+      #   AngellistApi.get_user_following
+      def get_user_following(id, options={})
+        get("/users/#{id}/following ", options, :format => :json, :phoenix => true)
+      end
+      
+      # Return ids of objects that the given user is following, paginated and ordered by most recent follow first. See the type parameter to specify which class of objects to return. Responds like GET /users/:id/followers/ids.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param id [Integer] The id of the given user.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :type Must be either user or startup. 
+      # @example Return ids of objects that the given user is following, paginated and ordered by most recent follow first. See the type parameter to specify which class of objects to return. Responds like GET /users/:id/followers/ids.
+      #   AngellistApi.get_user_following_ids
+      def get_user_following_ids(id, options={})
+        get("/users/#{id}/following/ids ", options, :format => :json, :phoenix => true)
+      end
+      
+      # Returns the given startup's followers, paginated and ordered by most recent follower first. Responds like GET /users/:id/followers.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param id [Integer] The id of the given user.
+      # @param options [Hash] A customizable set of options.
+      # @example Returns the given startup's followers, paginated and ordered by most recent follower first. Responds like GET /users/:id/followers.
+      #   AngellistApi.get_startup_followers
+      def get_startup_followers(id)
+        get("/startups/#{id}/followers", :format => :json, :phoenix => true)
+      end
+      
+      # Returns the ids of the given startup's followers, paginated and ordered by most recent follower first. Responds like GET /users/:id/followers.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param id [Integer] The id of the given user.
+      # @param options [Hash] A customizable set of options.
+      # @example Returns the ids of the given startup's followers, paginated and ordered by most recent follower first. Responds like GET /users/:id/followers.
+      #   AngellistApi.get_startup_follower_ids
+      def get_startup_follower_ids(id)
+        get("/startups/#{id}/followers/ids", :format => :json, :phoenix => true)
+      end
+    end
+  end
+end

data/lib/angellist_api/client/reviews.rb

@@ -0,0 +1,17 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    module Reviews
+      # Return reviews for the given user. If no user given, the authenticated user is used. Reviews are paginated and ordered by most recent first. Also returns the total count of positive reviews.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :user_id user_id of the desired user. If none given, defaults to the authenticated user. 
+      # @example Return reviews for the given user. If no user given, the authenticated user is used. Reviews are paginated and ordered by most recent first. Also returns the total count of positive reviews.
+      #   AngellistApi.get_reviews
+      def get_reviews(options={})
+        get("/reviews", options, :format => :json, :phoenix => true)
+      end
+    end
+  end
+end

data/lib/angellist_api/client/startup_roles.rb

@@ -0,0 +1,18 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    module StartupRoles      
+      # Given a startup_id, returns the users involved in that startup. Given a user_id, returns the startups that user is involved in. If neither parameter is given, the authenticated user is used. Possible roles include team_member, past_investor, advisor and referrer. Roles are paginated and ordered by most recently declared first.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :user_id The user who's startup relationships you want to view. 
+      # @option options [Integer] :startup_id  The startup who's user relationships you want to view. 
+      # @example Given a startup_id, returns the users involved in that startup. Given a user_id, returns the startups that user is involved in. If neither parameter is given, the authenticated user is used. Possible roles include team_member, past_investor, advisor and referrer. Roles are paginated and ordered by most recently declared first.
+      #   AngellistApi.get_startup_roles
+      def get_startup_roles(options={})
+        get("/startup_roles", options, :format => :json, :phoenix => true)
+      end
+    end
+  end
+end

data/lib/angellist_api/client/startups.rb

@@ -0,0 +1,28 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    module Startups
+      # Get a startup's information given an id.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param id [Integer] :id id of the desired startup.
+      # @example Get a startup's information given an id.
+      #   AngellistApi.get_startup
+      def get_startup(id)
+        get("/startups/#{id}", :format => :json, :phoenix => true)
+      end
+      
+      # Search for a startup given a URL slug. Responds like GET /startups/:id.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :slug The URL slug of the desired startup. 
+      # @option options [String] :domain The domain of the desired startup. Subdomains are not allowed. Keep in mind that startups can list any domain as their own. The startup with the most followers will be returned in the case of multiple hits. 
+      # @example Search for a startup given a URL slug. Responds like GET /startups/:id.
+      #   AngellistApi.startup_search
+      def startup_search(options={})
+        get("/startups/search", options, :format => :json, :phoenix => true)
+      end
+    end
+  end
+end

data/lib/angellist_api/client/status_updates.rb

@@ -0,0 +1,40 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    module StatusUpdates      
+      # Return status updates from the given user or startup. If neither is specified, the authenticated user is used. Status updates are paginated and ordered by most recent first.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :user_id id of the desired user. 
+      # @option options [Integer] :startup_id id of the desired startup. 
+      # @example Return status updates from the given user or startup. If neither is specified, the authenticated user is used. Status updates are paginated and ordered by most recent first.
+      #   AngellistApi.get_status_updates
+      def get_status_updates(options={})
+        get("/status_updates", options, :format => :json, :phoenix => true)
+      end
+      
+      # Creates a status update for the authenticated user or for a startup the authenticated user is a team member of. Returns the new status update on success, or an error on failure.
+      # @requires_authentication Yes
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :message The new status. Must be between 1 and 140 characters. 
+      # @option options [Integer] :startup_id id of the startup whose status you want to update. If unspecified, the authenticated user's status is updated. 
+      # @example Creates a status update for the authenticated user or for a startup the authenticated user is a team member of. Returns the new status update on success, or an error on failure.
+      #   AngellistApi.post_status_updates
+      def post_status_updates(options={})
+        post("/status_updates", options, :format => :json, :phoenix => true)
+      end
+      
+      # Destroys the specified status update belonging to the authenticated user or to a startup the authenticated user is a team member of. Returns the destroyed status update on success, or an error on failure.
+      # @requires_authentication Yes
+      # @response_format `json`
+      # @param id [Integer] id of the desired status message. 
+      # @example Destroys the specified status update belonging to the authenticated user or to a startup the authenticated user is a team member of. Returns the destroyed status update on success, or an error on failure.
+      #   AngellistApi.delete_status_updates
+      def delete_status_updates(id)
+        delete("/status_updates/#{id}", :format => :json, :phoenix => true)
+      end
+    end
+  end
+end

data/lib/angellist_api/client/tags.rb

@@ -0,0 +1,47 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    module Tags      
+      # Get information on a tag
+      # @requires_authentication No
+      # @response_format `json`
+      # @param id [Integer] id of the desired tag. 
+      # @example Get information on a tag
+      #   AngellistApi.get_tag
+      def get_tag(id)
+        get("/tags/#{id}", :format => :json, :phoenix => true)
+      end
+      
+      # Returns children of the given tag. Market and location tags form a Directed Acyclic Graph. Results are paginated and ordered by id descending.
+      # @requires_authentication No
+      # @response_format `json`
+      # @param id [Integer] The id of the desired tag. Currently only works for tags of type MarketTag or LocationTag. 
+      # @example Returns children of the given tag. Market and location tags form a Directed Acyclic Graph. Results are paginated and ordered by id descending.
+      #   AngellistApi.get_tag_children
+      def get_tag_children(id)
+        get("/tags/#{id}/children", :format => :json, :phoenix => true)
+      end
+      
+      # Returns parents of the given tag. For more details, see the documentation for GET /tags/:id/children.
+      # @requires_authentication No
+      # @response_format `json`
+      # @param id [Integer] The id of the desired tag. Currently only works for tags of type MarketTag or LocationTag. 
+      # @example Returns parents of the given tag. For more details, see the documentation for GET /tags/:id/children.
+      #   AngellistApi.get_tag_parents
+      def get_tag_parents(id)
+        get("/tags/#{id}/parents", :format => :json, :phoenix => true)
+      end
+      
+      # Returns startups that are tagged with the given tag or a child of the given tag. Results are paginated and ordered according to the order parameter.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :order May be one of popularity, asc or desc. Startups will be ordered by number of followers, ascending id or descending id, respectively. Defaults to desc
+      # @example Returns Returns startups that are tagged with the given tag or a child of the given tag. Results are paginated and ordered according to the order parameter.
+      #   AngellistApi.get_tag_startups
+      def get_tag_startups(options = {})
+        get("/tags/#{id}/startups", options, :format => :json, :phoenix => true)
+      end
+    end
+  end
+end

data/lib/angellist_api/client/users.rb

@@ -0,0 +1,37 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    module Users
+      # Get a user's information given an id.
+      # @requires_authentication No
+      # @response_format `json`
+      # @param id [Integer] :id id of the desired user.
+      # @example Get a user's information given an id.
+      #   AngellistApi.get_user
+      def get_user(id)
+        get("/users/#{id}", :format => :json, :phoenix => true)
+      end
+      
+      # Search for a user given a URL slug. Responds like GET /users/:id.
+      # @requires_authentication No
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :slug The URL slug of the desired user. 
+      # @option options [String] :md5 An md5 hash of the email address of the desired user. 
+      # @example Search for a user given a URL slug or md5 hash of an email address. Responds like GET /users/:id.
+      #   AngellistApi.user_search
+      def user_search(options={})
+        get("/users/search", options, :format => :json, :phoenix => true)
+      end
+      
+      # Get the current user's information. Responds like GET /users/:id.
+      # @requires_authentication Yes
+      # @response_format `json`
+      # @example Get the current user's information. Responds like GET /users/:id.
+      #   AngellistApi.user_search
+      def me
+        get("/me", :format => :json, :phoenix => true)
+      end
+    end
+  end
+end