angellist_api 1.0.1 → 1.0.2

data/lib/angellist_api/client/reviews.rb

@@ -1,17 +1,28 @@
 module AngellistApi
   class Client
     # Defines methods related to URLs
+    #
+    # @see http://angel.co/api/spec/reviews
     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.
+      # 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.
+      #
+      # @param [Hash] options 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 Get reviews for the authenticated user.
       #   AngellistApi.get_reviews
+      #
+      # @example Get reviews for a given user ID.
+      #   AngellistApi.get_reviews(:user_id => 1234)
       def get_reviews(options={})
-        get("1/reviews", options, :format => :json, :phoenix => true)
+        get("1/reviews", options)
       end
     end
   end
 end
+

data/lib/angellist_api/client/search.rb

@@ -0,0 +1,31 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    #
+    # @see http://angel.co/api/spec/search
+    module Search
+      # Search for Startups, Users, MarketTags and LocationTags, optionally
+      # narrowing the results by type. Results are sorted by a mix of match and
+      # popularity.
+      #
+      # @requires_authentication No
+      # @paginated No
+      #
+      # @param query [String] The search query. Will be URI-escaped.
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :type A scope for the query. Can be one of
+      #   'User', 'Startup', 'MarketTag' or 'LocationTag'.
+      #
+      # @example Search all data types.
+      #   AngellistApi.search('machine learning')
+      #
+      # @example Search locations.
+      #   AngellistApi.search('springfield', :type => 'LocationTag')
+      def search(query, options={})
+        options.merge!(:query => CGI.escape(query))
+        get("1/search", options)
+      end
+    end
+  end
+end
+

data/lib/angellist_api/client/startup_roles.rb

@@ -1,18 +1,33 @@
 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.
+    #
+    # @see http://angel.co/api/spec/startup_roles
+    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 founder, employee, past_investor, advisor, incubator 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.
+      #
+      # @param [Hash] options A customizable set of options.
+      # @option options [Integer] :user_id The user whose startup relationships
+      #   you want to view.
+      # @option options [Integer] :startup_id  The startup whose user
+      #   relationships you want to view.
+      #
+      # @example Get info about authenticated user's startups and roles.
       #   AngellistApi.get_startup_roles
+      #
+      # @example Get users involved in startup with ID 1234, and their roles.
+      #   AngellistApi.get_startup_roles(:startup_id => 1234)
       def get_startup_roles(options={})
-        get("1/startup_roles", options, :format => :json, :phoenix => true)
+        get("1/startup_roles", options)
       end
     end
   end
 end
+

data/lib/angellist_api/client/startups.rb

@@ -1,28 +1,64 @@
 module AngellistApi
   class Client
     # Defines methods related to URLs
+    #
+    # @see http://angel.co/api/spec/startups
     module Startups
-      # Get a startup's information given an id.
+      # 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
+      #
+      # @param [Integer] id ID of the desired startup.
+      #
+      # @example Get a startup's information given an ID.
+      #   AngellistApi.get_startup(1234)
       def get_startup(id)
-        get("1/startups/#{id}", :format => :json, :phoenix => true)
+        get("1/startups/#{id}")
       end
-      
+
+      # Returns the comments on the given startup.
+      #
+      # @requires_authentication Optional
+      # @paginated No
+      #
+      # @param id [Integer] ID of the desired startup.
+      #
+      # @example Get comments left about a startup with ID 1234.
+      #   AngellistApi.startup_comments(1234)
+      def startup_comments(id)
+        get("1/startups/#{id}/comments")
+      end
+
+      # Returns up to 50 startups at a time, given an Array of ids.
+      #
+      # @requires_authentication Optional
+      #
+      # @param ids [Array] IDs of the startups to fetch.
+      #
+      # @example Get information for a batch of startups.
+      #   AngellistApi.get_startups([1, 2, 3])
+      def get_startups(ids)
+        params = { :ids => ids.join(',') }
+        get("1/startups/batch", params)
+      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. 
+      #
+      # @param [Hash] options 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
+      #   AngellistApi.startup_search(:slug => '500-startups-fund')
       def startup_search(options={})
-        get("1/startups/search", options, :format => :json, :phoenix => true)
+        get("1/startups/search", options)
       end
     end
   end
 end
+

data/lib/angellist_api/client/status_updates.rb

@@ -1,40 +1,61 @@
 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.
+    #
+    # @see http://angel.co/api/spec/status_updates
+    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.
+      #
+      # @param [Hash] options 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 Get status updates for the authenticated user.
       #   AngellistApi.get_status_updates
+      #
+      # @example Get status updates for the startup with ID 1234.
+      #   AngellistApi.get_status_updates(:startup_id => 1234)
       def get_status_updates(options={})
-        get("1/status_updates", options, :format => :json, :phoenix => true)
+        get("1/status_updates", options)
       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.
+
+      # 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
+      #
+      # @param [Hash] options 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 Update the authenticated user's status.
+      #   AngellistApi.post_status_updates(:message => "Startup advice: Don't fuck up.")
       def post_status_updates(options={})
-        post("1/status_updates", options, :format => :json, :phoenix => true)
+        post("1/status_updates", options)
       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.
+
+      # 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
+      #
+      # @param [Integer] id ID of the desired status message.
+      #
+      # @example Destroys specified status update belonging to authenticated user.
+      #   AngellistApi.delete_status_updates(1234)
       def delete_status_updates(id)
-        delete("1/status_updates/#{id}", :format => :json, :phoenix => true)
+        delete("1/status_updates/#{id}")
       end
     end
   end
 end
+

data/lib/angellist_api/client/tags.rb

@@ -1,47 +1,69 @@
 module AngellistApi
   class Client
-    # Defines methods related to URLs
-    module Tags      
-      # Get information on a tag
+    # Defines methods related to URLs.
+    #
+    # @see http://angel.co/api/spec/tags
+    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
+      #
+      # @param [Integer] id ID of the desired tag.
+      #
+      # @example Get information on a tag.
+      #   AngellistApi.get_tag(1654)
       def get_tag(id)
-        get("1/tags/#{id}", :format => :json, :phoenix => true)
+        get("1/tags/#{id}")
       end
-      
-      # Returns children of the given tag. Market and location tags form a Directed Acyclic Graph. Results are paginated and ordered by id descending.
+
+      # 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
+      #
+      # @param [Integer] id The id of the desired tag. Currently only works for
+      #   tags of type MarketTag or LocationTag.
+      #
+      # @example Get children of a tag.
+      #   AngellistApi.get_tag_children(1654)
       def get_tag_children(id)
-        get("1/tags/#{id}/children", :format => :json, :phoenix => true)
+        get("1/tags/#{id}/children")
       end
-      
-      # Returns parents of the given tag. For more details, see the documentation for GET /tags/:id/children.
+
+      # 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
+      #
+      # @param [Integer] id The id of the desired tag. Currently only works for
+      #   tags of type MarketTag or LocationTag.
+      #
+      # @example Get parents of a tag.
+      #   AngellistApi.get_tag_parents(1654)
       def get_tag_parents(id)
-        get("1/tags/#{id}/parents", :format => :json, :phoenix => true)
+        get("1/tags/#{id}/parents")
       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.
+
+      # 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
+      #
+      # @param [Hash] options 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 Get startups tagged with tag ID or its children.
+      #   AngellistApi.get_tag_startups(1654)
+      #
+      # @see http://angel.co/api/spec/startups
       def get_tag_startups(id, options = {})
-        get("1/tags/#{id}/startups", options, :format => :json, :phoenix => true)
+        get("1/tags/#{id}/startups", options)
       end
     end
   end
 end
+

data/lib/angellist_api/client/users.rb

@@ -1,37 +1,59 @@
 module AngellistApi
   class Client
     # Defines methods related to URLs
+    #
+    # @see http://angel.co/api/spec/users
     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.
+      #
+      # @param [Integer] id ID of the desired user.
+      #
       # @example Get a user's information given an id.
-      #   AngellistApi.get_user
+      #   AngellistApi.get_user(1234)
       def get_user(id)
-        get("1/users/#{id}", :format => :json, :phoenix => true)
+        get("1/users/#{id}")
       end
-      
+
+      # Get information for a batch of up to 50 users given a list of user IDs.
+      #
+      # @requires_authentication No
+      #
+      # @param [Array] ids IDs of the users to fetch.
+      #
+      # @example Get information for a batch of users.
+      #   AngellistApi.get_users([1, 2, 3])
+      def get_users(ids)
+        params = { :ids => ids.join(',') }
+        get("1/users/batch", params)
+      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
+      #
+      # @param [Hash] options 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 by URL slug.
+      #   AngellistApi.user_search(:slug => '500startups')
       def user_search(options={})
-        get("1/users/search", options, :format => :json, :phoenix => true)
+        get("1/users/search", options)
       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
+      #
+      # @example Get the authenticated user's information.
+      #   AngellistApi.me
       def me
-        get("1/me", :format => :json, :phoenix => true)
+        get("1/me")
       end
     end
   end
 end
+