angellist_api 1.0.2 → 1.0.3

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Master
 
+## 1.0.3 - 10 March, 2013
+
+- Added press endpoint ([Evan Tann])
+- Added messages endpoint ([Paul Singh])
+- Added paths endpoint ([Ches Martin])
+- Established integration test setup for authenticated endpoints.
+
 ## 1.0.2 - 30 July, 2012
 
 - Loosen dependency requirements for faraday and multi_json, so we don't
@@ -23,5 +30,9 @@
   omniauth-angellist.
 
 
+[Paul Singh]: https://github.com/paulsingh
+[Ches Martin]: https://github.com/ches
+[Evan Tann]: https://github.com/egtann
+
 <!-- vim: set tw=80 :-->
 

data/README.md

@@ -1,22 +1,72 @@
-# The AngelList API Ruby Gem
+The AngelList API Ruby Gem
+==========================
 
-A Ruby wrapper for the [AngelList REST APIs][]. See the [YARD documentation][].
+A Ruby wrapper for the [AngelList REST APIs]. See the [YARD documentation] for
+usage details.
 
-## Installation
+Installation
+------------
 
     gem install angellist_api
 
-## Submitting a Pull Request
+Configuration
+-------------
+
+Some API endpoints require authentication. [Register your app] with
+AngelList to receive a [bearer token] and configure it as follows:
+
+```ruby
+AngellistApi.configure do |config|
+  config.access_token = '<your token here>'
+end
+```
+
+As bearer tokens are used, this library makes all requests over SSL. AngelList
+does permit unauthenticated requests over plain HTTP, but we make no
+distinction in this regard.
+
+[Register your app]: https://angel.co/api/oauth/clients
+[bearer token]: http://self-issued.info/docs/draft-ietf-oauth-v2-bearer.html
+
+Developing
+----------
+
+Run `bundle` to install development dependencies, then run all specs with
+`rake`. See `rake -T` for other possibilities.
+
+### Integration Tests for Authenticated Endpoints
+
+Integration tests should run against the [VCR] cassettes included in the
+repository out of the box. However, if you need to add new specs or change
+existing ones, you'll need to use your own private OAuth token. To do so, you
+can set an `ANGELLIST_ACCESS_TOKEN` environment variable, or set this variable
+through a [Foreman]-style `.env` file in the project directory. VCR's
+sensitive data filtering feature is used to prevent recording your private
+token.
+
+This means, though, that endpoints returning data specific to the
+authenticated user, such as messages or the `/me` endpoint, will require
+fixtures to be manually edited and maintained so that tests do not rely on
+real private information stored in the repository. The suggested workflow is
+to simply record a request once, then edit the body of the response in the
+cassette file, and set `:record => :none` for the spec(s) to prevent
+accidental overwrites when fixtures are updated *en masse* in the future.
+
+[VCR]: https://github.com/vcr/vcr
+[Foreman]: https://github.com/ddollar/foreman
+
+Submitting a Pull Request
+-------------------------
 
 1. Fork the project.
 2. Create a topic branch.
 3. Implement your feature or bug fix.
 4. Add documentation for your feature or bug fix.
-5. Run <tt>bundle exec rake doc:yard</tt>. If your changes are not 100%
-   documented, go back to step 4.
+5. Run `bundle exec rake doc:yard`. If your changes are not 100% documented,
+   go back to step 4.
 6. Add specs for your feature or bug fix.
-7. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go
-   back to step 6.
+7. Run `bundle exec rake spec`. If your changes are not 100% covered, go back
+   to step 6.
 8. Commit and push your changes.
 9. Submit a pull request. Please do not include changes to the gemspec,
    version, or history file. (If you want to create your own version for some

data/Rakefile

@@ -24,6 +24,6 @@ namespace :spec do
 end
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = ['lib/**/*.rb', 'README.md']
+  t.files   = ['lib/**/*.rb']
 end
 

data/lib/angellist_api/client.rb

@@ -13,6 +13,9 @@ module AngellistApi
     require 'angellist_api/client/activity_feeds'
     require 'angellist_api/client/follows'
     require 'angellist_api/client/jobs'
+    require 'angellist_api/client/messages'
+    require 'angellist_api/client/paths'
+    require 'angellist_api/client/press'
     require 'angellist_api/client/reviews'
     require 'angellist_api/client/search'
     require 'angellist_api/client/startups'
@@ -26,6 +29,9 @@ module AngellistApi
     include AngellistApi::Client::ActivityFeeds
     include AngellistApi::Client::Follows
     include AngellistApi::Client::Jobs
+    include AngellistApi::Client::Messages
+    include AngellistApi::Client::Paths
+    include AngellistApi::Client::Press
     include AngellistApi::Client::Reviews
     include AngellistApi::Client::Search
     include AngellistApi::Client::Startups
@@ -35,3 +41,4 @@ module AngellistApi
     include AngellistApi::Client::Users
   end
 end
+

data/lib/angellist_api/client/messages.rb

@@ -0,0 +1,45 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    #
+    # @see http://angel.co/api/spec/messages
+    module Messages
+      
+      # Returns threads that the authenticated user is involved in. A "thread"
+      # is a conversation between two users, where each message is tagged with
+      # the same thread_id. If the authenticated user has any unread messages 
+      #in the thread, the viewed attribute will be false. Requires scope "message".
+      #
+      # @requires_authentication Yes
+      # @paginated Yes
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [String] :view One of inbox, unread or sent. Defaults to inbox. 
+      #   The inbox view returns all threads in which the user has received at least 
+      #   one message. The unread view is a subset of the inbox view which only includes
+      #   threads with an unread message. The sent view returns all threads in which the 
+      #   user has sent at least one message.
+      # @option options [Integer] :thread_id Returns the messages for the given thread
+      #   that the authenticated user is involved in. The viewed attribute will be present
+      #   for messages that were sent to the authenticated user. Messages are paginated 
+      #   and ordered by message timestamp descending. Requires scope "message".
+      def get_messages(options={})
+        get("1/messages", options)
+      end
+      
+      # Creates a new message from the authenticated user to the other participant of the 
+      # given thread. Returns the new message on success. Requires scope "message".
+      #
+      # @requires_authentication Yes
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :recipient_id The id of the user receiving the message
+      # @option options [Integer] :thread_id The id of the thread that you want the message 
+      #   to be attached to. 
+      # @option options [String] :body The body of the message.
+      def post_messages(options={})
+        post("1/messages", options)
+      end
+    end
+  end
+end

data/lib/angellist_api/client/paths.rb

@@ -0,0 +1,39 @@
+module AngellistApi
+  class Client
+    # Defines methods related to path resources (social connections)
+    #
+    # @see http://angel.co/api/spec/paths
+    module Paths
+      # Show paths between you and given user/startup ids.
+      #
+      # Additional notes:
+      #
+      # - for each user/startup up to 10 different paths will show up
+      # - up to 20 ids per request are allowed
+      # - do not use user_ids and startup_ids at the same time
+      #
+      # @requires_authentication Yes
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [Array<Integer>] :user_ids Show paths between you and
+      #   these users
+      # @option options [Array<Integer>] :startup_ids Show paths between you
+      #   and these startups
+      # @option options [string] :direction "following" or "followed"
+      #
+      # @todo This is a great case for a 2.0 version of our lib that has some
+      #   real OOP abstraction -- the results of this as a dumb hash are pretty
+      #   disgusting to work with.
+      def get_paths(options={})
+        user_ids = options.delete(:user_ids) { [] }
+        startup_ids = options.delete(:startup_ids) { [] }
+
+        options.merge!(:user_ids => user_ids.join(',')) if user_ids.any?
+        options.merge!(:startup_ids => startup_ids.join(',')) if startup_ids.any?
+
+        get('1/paths', options)
+      end
+    end
+  end
+end
+

data/lib/angellist_api/client/press.rb

@@ -0,0 +1,25 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    #
+    # @see http://angel.co/api/spec/press
+    module Press
+      
+      # Return press for the given startup. Press is paginated and ordered by
+      # most recent first, according to the post date.
+      #
+      # @requires_authentication No
+      # @paginated Yes
+      #
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :startup_id Specifies the desired startup
+      # @option options [Integer] :page Specifies the page of results to
+      #   retrieve.
+      # @option options [Integer] :per_page (50) The number of results to return
+      #   for a page. Maximum of 50.
+      def get_press(options={})
+        get("1/press", options)
+      end
+    end
+  end
+end

data/lib/angellist_api/version.rb

@@ -1,4 +1,4 @@
 module AngellistApi
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end
 

data/spec/fixtures/cassettes/messages.yml

@@ -0,0 +1,100 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.angel.co/1/messages
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - AngellistApi Ruby Gem 1.0.2
+      Authorization:
+      - Bearer <ANGELLIST_ACCESS_TOKEN>
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      cache-control:
+      - !binary |-
+        cHJpdmF0ZSwgbWF4LWFnZT0wLCBtdXN0LXJldmFsaWRhdGU=
+      content-type:
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      date:
+      - !binary |-
+        U3VuLCAxMCBNYXIgMjAxMyAxODowNzozMSBHTVQ=
+      etag:
+      - !binary |-
+        IjRjYTk5YmRiODgxNGM5MGI2N2I3NTc4NjI3ZTM1M2VmIg==
+      server:
+      - !binary |-
+        bmdpbng=
+      status:
+      - !binary |-
+        MjAwIE9L
+      vary:
+      - !binary |-
+        QWNjZXB0LUVuY29kaW5n
+      x-ratelimit-limit:
+      - !binary |-
+        MjAwMA==
+      x-ratelimit-remaining:
+      - !binary |-
+        MjAwMA==
+      x-runtime:
+      - !binary |-
+        NDI=
+      !binary "Y29udGVudC1sZW5ndGg=":
+      - !binary |-
+        ODQy
+      connection:
+      - !binary |-
+        Q2xvc2U=
+    body:
+      encoding: ASCII-8BIT
+      string: |-
+        {
+          "messages": [
+            {
+              "users": [
+                {
+                  "name": "Ches Martin",
+                  "id": 65956,
+                  "bio": "typing one-line bios is one of my hobbies. I'm not very good at it, hence I don't do it professionally.",
+                  "follower_count": 43,
+                  "angellist_url": "https://angel.co/ches",
+                  "image": "https://s3.amazonaws.com/photos.angel.co/users/65956-medium_jpg?1318831341"
+                }, {
+                  "name": "Paul Singh",
+                  "id": 1274,
+                  "bio": "Partner at 500 Startups",
+                  "follower_count": 5457,
+                  "angellist_url": "https://angel.co/paulsingh",
+                  "image": "https://s3.amazonaws.com/photos.angel.co/users/1274-medium_jpg?1359423366"
+                }
+              ],
+              "total": 1,
+              "viewed": true,
+              "thread_id": 1234,
+              "last_message": {
+                "id": 4321,
+                "body": "Paul, it will be glorious, I tell you.",
+                "recipient_id": 1274,
+                "sender_id": 65956,
+                "created_at": "2013-03-11T03:53:30Z",
+                "viewed": true
+              }
+            }
+          ],
+          "total": 1,
+          "per_page": 50,
+          "page": 1,
+          "last_page": 1
+        }
+    http_version: 
+  recorded_at: Sun, 10 Mar 2013 18:07:32 GMT
+recorded_with: VCR 2.4.0

data/spec/fixtures/cassettes/paths.yml

@@ -0,0 +1,266 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.angel.co/1/paths?user_ids=1274
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - AngellistApi Ruby Gem 1.0.2
+      Authorization:
+      - Bearer <ANGELLIST_ACCESS_TOKEN>
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      cache-control:
+      - !binary |-
+        cHJpdmF0ZSwgbWF4LWFnZT0wLCBtdXN0LXJldmFsaWRhdGU=
+      content-type:
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      date:
+      - !binary |-
+        U3VuLCAxMCBNYXIgMjAxMyAyMTozMTowOCBHTVQ=
+      etag:
+      - !binary |-
+        ImM0ZGNhZWJmNWVhZjM3MmU1ZjJjNTNlOWQ5ZDY5ZGViIg==
+      server:
+      - !binary |-
+        bmdpbng=
+      status:
+      - !binary |-
+        MjAwIE9L
+      vary:
+      - !binary |-
+        QWNjZXB0LUVuY29kaW5n
+      x-ratelimit-limit:
+      - !binary |-
+        MjAwMA==
+      x-ratelimit-remaining:
+      - !binary |-
+        MjAwMA==
+      x-runtime:
+      - !binary |-
+        MTE3
+      transfer-encoding:
+      - !binary |-
+        Y2h1bmtlZA==
+      connection:
+      - !binary |-
+        Q2xvc2U=
+    body:
+      encoding: ASCII-8BIT
+      string: |-
+        {
+          "1274": [
+            [
+              {
+                "connector": {
+                  "id": 65956,
+                  "type": "User",
+                  "name": "Ches Martin",
+                  "image": "https://s3.amazonaws.com/photos.angel.co/users/65956-medium_jpg?1318831341",
+                  "angellist_url": "https://angel.co/ches"
+                },
+                "connection": {
+                  "type": "explicit",
+                  "via": null,
+                  "in": null,
+                  "out": null
+                }
+              },
+              {
+                "connector": {
+                  "id": 1274,
+                  "type": "User",
+                  "name": "Paul Singh",
+                  "image": "https://s3.amazonaws.com/photos.angel.co/users/1274-medium_jpg?1359423366",
+                  "angellist_url": "https://angel.co/paulsingh"
+                },
+                "connection": {
+                  "type": null,
+                  "via": null,
+                  "in": null,
+                  "out": null
+                }
+              }
+            ], [
+              {
+                "connector": {
+                  "id": 65956,
+                  "type": "User",
+                  "name": "Ches Martin",
+                  "image": "https://s3.amazonaws.com/photos.angel.co/users/65956-medium_jpg?1318831341",
+                  "angellist_url": "https://angel.co/ches"
+                },
+                "connection": {
+                  "type": "explicit",
+                  "via": null,
+                  "in": null,
+                  "out": null
+                }
+              },
+              {
+                "connector": {
+                  "id": 12431,
+                  "type": "User",
+                  "name": "Brenden Mulligan",
+                  "image": "https://s3.amazonaws.com/photos.angel.co/users/12431-medium_jpg?1325658149",
+                  "angellist_url": "https://angel.co/mulligan"
+                },
+                "connection": {
+                  "type": "startup_role",
+                  "via": {
+                    "id": 15762,
+                    "type": "Startup",
+                    "name": "WillCall",
+                    "image": "https://s3.amazonaws.com/photos.angel.co/startups/i/15762-eba2e37a308bc4faf3949312efe57a6a-thumb_jpg.jpg?buster=1331066434",
+                    "angellist_url": "https://angel.co/willcall"
+                  },
+                  "in": "advisor",
+                  "out": "past_investor"
+                }
+              },
+              {
+                "connector": {
+                  "id": 1274,
+                  "type": "User",
+                  "name": "Paul Singh",
+                  "image":  "https://s3.amazonaws.com/photos.angel.co/users/1274-medium_jpg?1359423366",
+                  "angellist_url": "https://angel.co/paulsingh"
+                },
+                "connection": {
+                  "type": null,
+                  "via": null,
+                  "in": null,
+                  "out": null
+                }
+              }
+            ]
+          ]
+        }
+    http_version: 
+  recorded_at: Sun, 10 Mar 2013 21:31:08 GMT
+- request:
+    method: get
+    uri: https://api.angel.co/1/paths?startup_ids=76155
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - AngellistApi Ruby Gem 1.0.2
+      Authorization:
+      - Bearer <ANGELLIST_ACCESS_TOKEN>
+  response:
+    status:
+      code: 200
+      message: 
+    headers:
+      cache-control:
+      - !binary |-
+        cHJpdmF0ZSwgbWF4LWFnZT0wLCBtdXN0LXJldmFsaWRhdGU=
+      content-type:
+      - !binary |-
+        YXBwbGljYXRpb24vanNvbjsgY2hhcnNldD11dGYtOA==
+      date:
+      - !binary |-
+        U3VuLCAxMCBNYXIgMjAxMyAyMzoxNTozNyBHTVQ=
+      etag:
+      - !binary |-
+        IjBkNTQ1NmViNjk2YmUxMjliZjliYjcwMzE3YWNkMWQ4Ig==
+      server:
+      - !binary |-
+        bmdpbng=
+      status:
+      - !binary |-
+        MjAwIE9L
+      vary:
+      - !binary |-
+        QWNjZXB0LUVuY29kaW5n
+      x-ratelimit-limit:
+      - !binary |-
+        MjAwMA==
+      x-ratelimit-remaining:
+      - !binary |-
+        MTk5OA==
+      x-runtime:
+      - !binary |-
+        MTM5
+      transfer-encoding:
+      - !binary |-
+        Y2h1bmtlZA==
+      connection:
+      - !binary |-
+        Q2xvc2U=
+    body:
+      encoding: ASCII-8BIT
+      string: |-
+        {
+          "76155": [
+            [
+              {
+                "connector": {
+                  "id": 65956,
+                  "type": "User",
+                  "name": "Ches Martin",
+                  "image": "https://s3.amazonaws.com/photos.angel.co/users/65956-medium_jpg?1318831341",
+                  "angellist_url": "https://angel.co/ches"
+                },
+                "connection": {
+                  "type": "explicit",
+                  "via": null,
+                  "in": null,
+                  "out": null
+                }
+              },
+              {
+                "connector": {
+                  "id": 6120,
+                  "type": "User",
+                  "name": "Ed Roman",
+                  "image":  "https://s3.amazonaws.com/photos.angel.co/users/6120-medium_jpg?1300500084",
+                  "angellist_url": "https://angel.co/edro"
+                },
+                "connection": {
+                  "type": "startup_role",
+                  "via": {
+                    "id": 76155,
+                    "type": "Startup",
+                    "name": "Precog",
+                    "image": "https://s3.amazonaws.com/photos.angel.co/startups/i/76155-a20caa2b50a9be81f9afec7b9c018c59-thumb_jpg.jpg?buster=1331733354",
+                    "angellist_url": "https://angel.co/precog"
+                  },
+                  "in": "referrer",
+                  "out": "referrer"
+                }
+              },
+              {
+                "connector": {
+                  "id": 76155,
+                  "type": "Startup",
+                  "name": "Precog",
+                  "image": "https://s3.amazonaws.com/photos.angel.co/startups/i/76155-a20caa2b50a9be81f9afec7b9c018c59-thumb_jpg.jpg?buster=1331733354",
+                  "angellist_url": "https://angel.co/precog"
+                },
+                "connection": {
+                  "type": null,
+                  "via": null,
+                  "in": null,
+                  "out": null
+                }
+              }
+            ]
+          ]
+        }
+    http_version: 
+  recorded_at: Sun, 10 Mar 2013 23:15:38 GMT
+recorded_with: VCR 2.4.0