angellist_api 0.1.0 → 0.1.2

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 0.1.2 - 22 March, 2012
+
+- Relax Hashie dependency, in particular to avoid dep conflict with
+  omniauth-angellist.
+
+
+<!-- vim: set tw=80 :-->
+

data/README.md

@@ -1,10 +1,13 @@
 # The AngelList API Ruby Gem
-A Ruby wrapper for the AngelList REST APIs
+
+A Ruby wrapper for the [AngelList REST APIs][].
 
 ## <a name="installation">Installation</a>
-    gem install angellist-api
+
+    gem install angellist_api
 
 ## <a name="pulls">Submitting a Pull Request</a>
+
 1. Fork the project.
 2. Create a topic branch.
 3. Implement your feature or bug fix.
@@ -14,3 +17,6 @@ A Ruby wrapper for the AngelList REST APIs
 7. Run <tt>bundle exec rake spec</tt>. 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 reason, please do so in a separate commit.)
+
+[AngelList REST APIs]: http://angel.co/api
+

data/Rakefile

@@ -1,37 +1,20 @@
-#!/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
-
 
+require 'yard'
 
 Bundler::GemHelper.install_tasks
 
-require 'rake/testtask'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
+task :test => :spec
+task :default => :spec
 
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'README.md']
+end
 
-task :default => :test

data/lib/angellist_api/authentication.rb

@@ -8,10 +8,7 @@ module AngellistApi
     # @return [Hash]
     def authentication
       {
-        :consumer_key => consumer_key,
-        :consumer_secret => consumer_secret,
-        :token => oauth_token,
-        :token_secret => oauth_token_secret,
+        :access_token => respond_to?(:access_token) ? access_token : nil,
       }
     end
 

data/lib/angellist_api/client.rb

@@ -6,6 +6,7 @@ module AngellistApi
     # 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/activity_feeds'
     require 'angellist_api/client/follows'
     require 'angellist_api/client/reviews'
     require 'angellist_api/client/startups'
@@ -16,6 +17,7 @@ module AngellistApi
 
     alias :api_endpoint :endpoint
 
+    include AngellistApi::Client::ActivityFeeds
     include AngellistApi::Client::Follows
     include AngellistApi::Client::Reviews
     include AngellistApi::Client::Startups

data/lib/angellist_api/client/activity_feeds.rb

@@ -0,0 +1,19 @@
+module AngellistApi
+  class Client
+    # Defines methods related to URLs
+    module ActivityFeeds
+      
+      # Returns site activity. If authenticated and the personalized parameter is passed in, only activity from the authenticated user's social graph is returned. No more than 25 items will be returned. Results are paginated and ordered by most recent story first.
+      # @requires_authentication Optional
+      # @response_format `json`
+      # @param options [Hash] A customizable set of options.
+      # @option options [Integer] :personalized If set to 1 and a user is authenticated, only activity from the authenticated user's social graph is returned.
+      # @example 
+      #   AngellistApi.get_feed
+      def get_feed(options={})
+        get("1/feed", options, :format => :json, :phoenix => true)
+      end
+      
+    end
+  end
+end

data/lib/angellist_api/client/follows.rb

@@ -55,7 +55,7 @@ module AngellistApi
       # @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("1/users/#{id}/following ", options, :format => :json, :phoenix => true)
+        get("1/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.
@@ -67,7 +67,7 @@ module AngellistApi
       # @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("1/users/#{id}/following/ids ", options, :format => :json, :phoenix => true)
+        get("1/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.

data/lib/angellist_api/client/tags.rb

@@ -39,7 +39,7 @@ module AngellistApi
       # @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 = {})
+      def get_tag_startups(id, options = {})
         get("1/tags/#{id}/startups", options, :format => :json, :phoenix => true)
       end
     end

data/lib/angellist_api/configuration.rb

@@ -6,13 +6,10 @@ module AngellistApi
     # 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,
+      :access_token,
       :proxy,
       :user_agent,
       :faraday_options].freeze
@@ -20,12 +17,6 @@ module AngellistApi
     # 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/".freeze
 
@@ -34,11 +25,8 @@ module AngellistApi
     # @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 set a user oauth access token
+    DEFAULT_ACCESS_TOKEN = nil
 
     # By default, don't use a proxy server
     DEFAULT_PROXY = nil
@@ -73,12 +61,9 @@ module AngellistApi
     # 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.access_token       = DEFAULT_ACCESS_TOKEN
       self.proxy              = DEFAULT_PROXY
       self.user_agent         = DEFAULT_USER_AGENT
       self.gateway            = DEFAULT_GATEWAY

data/lib/angellist_api/connection.rb

@@ -2,7 +2,7 @@ require 'faraday_middleware'
 require 'faraday/request/phoenix'
 require 'faraday/request/multipart_with_file'
 require 'faraday/request/gateway'
-require 'faraday/request/twitter_oauth'
+require 'faraday/request/angellist_api_oauth'
 require 'faraday/response/raise_http_4xx'
 require 'faraday/response/raise_http_5xx'
 

data/lib/angellist_api/request.rb

@@ -37,7 +37,7 @@ module AngellistApi
     end
 
     def formatted_path(path, options={})
-      [path, options.fetch(:format, format)].compact.join('.')
+      path
     end
   end
 end

data/lib/angellist_api/version.rb

@@ -1,3 +1,4 @@
 module AngellistApi
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end
+

data/lib/faraday/request/angellist_api_oauth.rb

@@ -0,0 +1,14 @@
+require 'faraday'
+
+module Faraday
+  class Request::AngellistApiOAuth < Faraday::Middleware
+    def call(env)
+      env[:request_headers]['Authorization'] = "Bearer #{@options[:access_token]}" if @options[:access_token]
+      @app.call(env)
+    end
+
+    def initialize(app, options)
+      @app, @options = app, options
+    end
+  end
+end

data/spec/lib/angellist_api/api_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe AngellistApi::API do
+  
+  describe "#initialize" do
+    context "without passing new options" do
+      it "should use the default options" do
+        api = AngellistApi::API.new
+        AngellistApi::Configuration::VALID_OPTIONS_KEYS.each do |valid_key|
+          api.send(valid_key).should == AngellistApi.options[valid_key]
+        end
+      end
+    end
+    
+    context "while passing custom options" do
+      it "should use the new options" do
+        key_to_overwrite = AngellistApi.options.keys.first
+        overwrite_value  = "NEW VALUE!!"
+        
+        api = AngellistApi::API.new(key_to_overwrite => overwrite_value)
+        AngellistApi::Configuration::VALID_OPTIONS_KEYS.each do |valid_key|
+          expected_value = valid_key == key_to_overwrite ? overwrite_value : AngellistApi.options[valid_key]
+          api.send(valid_key).should == expected_value
+        end
+      end
+    end
+  end
+  
+  describe "configuration" do
+    before(:each) do
+      @api = AngellistApi::API.new
+    end
+    
+    AngellistApi::Configuration::VALID_OPTIONS_KEYS.each do |config_key|
+      it "should allow the value of #{config_key} to be set" do
+        lambda { @api.send("#{config_key}=", "SOME NEW VALUE") }.should_not raise_error
+        @api.send(config_key).should == "SOME NEW VALUE"
+      end
+    end
+  end
+  
+end

data/spec/lib/angellist_api/authentication_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe AngellistApi::Authentication do
+  class BasicClass
+    include AngellistApi::Authentication
+  end
+  
+  class FullClass
+    include AngellistApi::Authentication
+    attr_accessor :access_token
+  end
+
+  describe "#authentication" do
+    context "without auth variables defined" do
+      it "should return a hash with nil values" do
+        a = BasicClass.new
+        a.send(:authentication).values.any?.should be_false
+      end
+    end
+    
+    context "with auth variables defined" do
+      before(:each) do
+        @a = FullClass.new
+      end
+      
+      it "should return a hash with nil values if auth variables are not set" do
+        @a.send(:authentication).values.all?.should be_false
+      end
+
+      it "should return a hash with nil values if auth variables are set" do
+        @a.access_token = "token"
+        @a.send(:authentication).values.all?.should be_true
+      end
+    end
+  end
+  
+  describe "#authenticated?" do
+    before(:each) do
+      @a = FullClass.new
+    end
+        
+    it "should return false if authentication has any nil values" do
+      @a.expects(:authentication).returns({:access_token=>nil})
+      @a.send(:authenticated?).should be_false
+    end
+    
+    it "should return true if authentication has no nil values" do
+      @a.expects(:authentication).returns({:access_token=>"1"})
+      @a.send(:authenticated?).should be_true
+    end
+  end
+
+end

data/spec/lib/angellist_api/client/activity_feeds_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe AngellistApi::Client::ActivityFeeds do
+  before(:each) do
+    @client = AngellistApi::Client.new
+  end
+  
+  describe "#get_feed" do
+    it "should get 1/feed" do
+      options = { :some => "options" }
+      @client.expects(:get).with("1/feed", options, :format => :json, :phoenix => true).returns("success")
+      @client.get_feed(options).should == "success"
+    end
+  end
+  
+end

data/spec/lib/angellist_api/client/follows_spec.rb

@@ -0,0 +1,74 @@
+require 'spec_helper'
+
+describe AngellistApi::Client::Follows do
+  before(:each) do
+    @client = AngellistApi::Client.new
+  end
+  
+  describe "#new_follow" do
+    it "should post to 1/follows" do
+      options = { :some => "options" }
+      @client.expects(:post).with("1/follows", options, :format => :json, :phoenix => true).returns("success")
+      @client.new_follow(options).should == "success"
+    end
+  end
+  
+  describe "#delete_follow" do
+    it "should delete 1/follows" do
+      options = { :some => "options" }
+      @client.expects(:delete).with("1/follows", options, :format => :json, :phoenix => true).returns("success")
+      @client.delete_follow(options).should == "success"
+    end
+  end
+
+  describe "#get_user_followers" do
+    it "should get 1/users/<id>/followers" do
+      id = "123"
+      @client.expects(:get).with("1/users/#{id}/followers", :format => :json, :phoenix => true).returns("success")
+      @client.get_user_followers(id).should == "success"
+    end
+  end
+
+  describe "#get_user_follower_ids" do
+    it "should get 1/users/<id>/followers/ids" do
+      id = "123"
+      @client.expects(:get).with("1/users/#{id}/followers/ids", :format => :json, :phoenix => true).returns("success")
+      @client.get_user_follower_ids(id).should == "success"
+    end
+  end
+
+  describe "#get_user_following" do
+    it "should get 1/users/<id>/following" do
+      id = "123"
+      options = { :some => "options" }
+      @client.expects(:get).with("1/users/#{id}/following", options, :format => :json, :phoenix => true).returns("success")
+      @client.get_user_following(id, options).should == "success"
+    end
+  end
+
+  describe "#get_user_following_ids" do
+    it "should get 1/users/<id>/following/ids" do
+      id = "123"
+      options = { :some => "options" }
+      @client.expects(:get).with("1/users/#{id}/following/ids", options, :format => :json, :phoenix => true).returns("success")
+      @client.get_user_following_ids(id, options).should == "success"
+    end
+  end
+
+  describe "#get_startup_followers" do
+    it "should get 1/startups/<id>/followers" do
+      id = "123"
+      @client.expects(:get).with("1/startups/#{id}/followers", :format => :json, :phoenix => true).returns("success")
+      @client.get_startup_followers(id).should == "success"
+    end
+  end
+
+  describe "#get_startup_follower_ids" do
+    it "should get 1/startups/<id>/followers/ids" do
+      id = "123"
+      @client.expects(:get).with("1/startups/#{id}/followers/ids", :format => :json, :phoenix => true).returns("success")
+      @client.get_startup_follower_ids(id).should == "success"
+    end
+  end
+
+end

data/spec/lib/angellist_api/client/reviews_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe AngellistApi::Client::Reviews do
+  before(:each) do
+    @client = AngellistApi::Client.new
+  end
+  
+  describe "#get_reviews" do
+    it "should get 1/reviews" do
+      options = { :some => "options" }
+      @client.expects(:get).with("1/reviews", options, :format => :json, :phoenix => true).returns("success")
+      @client.get_reviews(options).should == "success"
+    end
+  end
+  
+end