octokit 1.25.0 → 2.0.0.pre

data/spec/octokit/client_spec.rb

@@ -2,245 +2,395 @@ require 'helper'
 
 describe Octokit::Client do
 
-  before do
-    File.chmod 0600, "spec/fixtures/.netrc"
-    Octokit.reset
-  end
-
-  it "sets a default user agent" do
-    stub_request(:get, "https://api.github.com/rate_limit").
-      with(:headers => {:user_agent => Octokit.user_agent }).
-      to_return(:status => 200, :body => '', :headers =>
-        { 'X-RateLimit-Limit' => 5000, 'X-RateLimit-Remaining' => 5000})
-
-    Octokit.rate_limit
-  end
-
-  it "allows a custom user agent" do
-    Octokit.user_agent = 'My mashup'
-
-    stub_request(:get, "https://api.github.com/rate_limit").
-      with(:headers => {:user_agent => 'My mashup' }).
-      to_return(:status => 200, :body => '', :headers =>
-        { 'X-RateLimit-Limit' => 5000, 'X-RateLimit-Remaining' => 5000})
-
-    Octokit.rate_limit
-  end
-
-  it "works with basic auth and password" do
-    stub_get("https://foo:bar@api.github.com/repos/baz/quux/commits?per_page=35&sha=master").
-      to_return(:status => 200, :body => '{"commits":[]}', :headers => {})
-    expect {
-      Octokit::Client.new(:login => 'foo', :password => 'bar').commits('baz/quux')
-    }.not_to raise_exception
-  end
+  describe "module configuration" do
+
+    before do
+      Octokit.reset!
+      Octokit.configure do |config|
+        Octokit::Configurable.keys.each do |key|
+          config.send("#{key}=", "Some #{key}")
+        end
+      end
+    end
 
-  it "can read .netrc files" do
-    stub_get("https://sferik:il0veruby@api.github.com/user").
-      to_return(json_response("user.json"))
-    Octokit.reset
-    client = Octokit::Client.new(:netrc => File.join(fixture_path, '.netrc'))
-    user = client.user
-    expect(user.login).to eq("sferik")
-  end
+    after do
+      Octokit.reset!
+    end
 
-  it "can read non-standard API endpoint creds from .netrc" do
-    stub_get("http://defunkt:il0veruby@api.github.dev/user").
-      to_return(json_response("user.json"))
-    Octokit.reset
-    Octokit.api_endpoint = "http://api.github.dev"
-    client = Octokit::Client.new(:netrc => File.join(fixture_path, '.netrc'))
-    user = client.user
-    expect(user.followers).to eq(205)
-  end
+    it "inherits the module configuration" do
+      client = Octokit::Client.new
+      Octokit::Configurable.keys.each do |key|
+        expect(client.instance_variable_get(:"@#{key}")).to eq "Some #{key}"
+      end
+    end
 
-  it "configures faraday from faraday_config_block" do
-    mw_evaluated = false
-    Octokit.configure do |c|
-      c.faraday_config { |f| mw_evaluated = true }
-    end
-    stub_request(:get, "https://api.github.com/rate_limit").
-      to_return(:status => 200, :body => '', :headers =>
-                { 'X-RateLimit-Limit' => 5000, 'X-RateLimit-Remaining' => 5000})
-    client = Octokit::Client.new()
-    client.rate_limit
-    expect(mw_evaluated).to eq(true)
+    describe "with class level configuration" do
+
+      before do
+        @opts = {
+          :connection_options => {:ssl => {:verify => false}},
+          :per_page => 40,
+          :login    => "defunkt",
+          :password => "il0veruby"
+        }
+      end
+
+      it "overrides module configuration" do
+        client = Octokit::Client.new(@opts)
+        expect(client.per_page).to eq 40
+        expect(client.login).to eq "defunkt"
+        expect(client.instance_variable_get(:"@password")).to eq "il0veruby"
+        expect(client.auto_paginate).to eq Octokit.auto_paginate
+        expect(client.client_id).to eq Octokit.client_id
+      end
+
+      it "can set configuration after initialization" do
+        client = Octokit::Client.new
+        client.configure do |config|
+          @opts.each do |key, value|
+            config.send("#{key}=", value)
+          end
+        end
+        expect(client.per_page).to eq 40
+        expect(client.login).to eq "defunkt"
+        expect(client.instance_variable_get(:"@password")).to eq "il0veruby"
+        expect(client.auto_paginate).to eq Octokit.auto_paginate
+        expect(client.client_id).to eq Octokit.client_id
+      end
+
+      it "masks passwords on inspect" do
+        client = Octokit::Client.new(@opts)
+        inspected = client.inspect
+        expect(inspected).to_not include "il0veruby"
+      end
+
+      it "masks tokens on inspect" do
+        client = Octokit::Client.new(:access_token => '87614b09dd141c22800f96f11737ade5226d7ba8')
+        inspected = client.inspect
+        expect(inspected).to_not match "87614b09dd141c22800f96f11737ade5226d7ba8"
+      end
+
+      it "masks client secrets on inspect" do
+        client = Octokit::Client.new(:client_secret => '87614b09dd141c22800f96f11737ade5226d7ba8')
+        inspected = client.inspect
+        expect(inspected).to_not match "87614b09dd141c22800f96f11737ade5226d7ba8"
+      end
+
+      describe "with .netrc" do
+        it "can read .netrc files" do
+          Octokit.reset!
+          client = Octokit::Client.new \
+            :netrc => true,
+            :netrc_file => File.join(fixture_path, '.netrc')
+          expect(client.login).to eq "sferik"
+          expect(client.instance_variable_get(:"@password")).to eq "il0veruby"
+        end
+
+        it "can read non-standard API endpoint creds from .netrc" do
+          Octokit.reset!
+          client = Octokit::Client.new \
+            :netrc => true,
+            :netrc_file => File.join(fixture_path, '.netrc'),
+            :api_endpoint => 'http://api.github.dev'
+          expect(client.login).to eq "defunkt"
+          expect(client.instance_variable_get(:"@password")).to eq "il0veruby"
+        end
+      end
+    end
   end
 
-
-  describe "auto_traversal" do
-
-    it "traverses a paginated response using the maximum allowed number of items per page" do
-      stub_get("https://api.github.com/foo/bar?per_page=100").
-        to_return \
-          :status => 200,
-          :body => %q{["stuff"]},
-          :headers => {
-            :content_type => 'application/json; charset=utf-8',
-            :link => %q{<https://api.github.com/foo/bar?page=2>; rel="next", <https://api.github.com/foo/bar?page=3>; rel="last"}
-          }
-
-      stub_get("https://api.github.com/foo/bar?page=2&per_page=100").
-        to_return \
-          :status => 200,
-          :body => %q{["even more stuff"]},
-          :headers => {
-            :content_type => 'application/json; charset=utf-8',
-            :link => %q{<https://api.github.com/foo/bar?page=3>; rel="next", <https://api.github.com/foo/bar?page=3>; rel="last", <https://api.github.com/foo/bar?page=1>; rel="prev", <https://api.github.com/foo/bar?page=1>; rel="first"}
-          }
-
-      stub_get("https://api.github.com/foo/bar?page=3&per_page=100").
-        to_return \
-          :status => 200,
-          :body => %q{["stuffapalooza"]},
-          :headers => {
-            :content_type => 'application/json; charset=utf-8',
-            :link => %q{<https://api.github.com/foo/bar?page=2>; rel="prev", <https://api.github.com/foo/bar?page=1>; rel="first"}
-          }
-
-      expect(Octokit::Client.new(:auto_traversal => true).get("https://api.github.com/foo/bar")).to eq(['stuff', 'even more stuff', 'stuffapalooza'])
+  describe "authentication" do
+    before do
+      Octokit.reset!
+      @client = Octokit.client
     end
 
-    it "uses the number set in the per_page configuration option when present" do
-      stub_get("https://api.github.com/foo/bar?per_page=50").
-        to_return(:status => 200, :body => %q{["stuff"]}, :headers =>
-          { :link => %q{<https://api.github.com/foo/bar?page=2>; rel="next", <https://api.github.com/foo/bar?page=3>; rel="last"} })
-
-      stub_get("https://api.github.com/foo/bar?page=2&per_page=50").
-        to_return(:status => 200, :body => %q{["even more stuff"]}, :headers =>
-          { :link => %q{<https://api.github.com/foo/bar?page=3>; rel="last", <https://api.github.com/foo/bar?page=1>; rel="prev", <https://api.github.com/foo/bar?page=1>; rel="first"} })
+    describe "with module level config" do
+      before do
+        Octokit.reset!
+      end
+      it "sets basic auth creds with .configure" do
+        Octokit.configure do |config|
+          config.login = 'pengwynn'
+          config.password = 'il0veruby'
+        end
+        expect(Octokit.client).to be_basic_authenticated
+      end
+      it "sets basic auth creds with module methods" do
+        Octokit.login = 'pengwynn'
+        Octokit.password = 'il0veruby'
+        expect(Octokit.client).to be_basic_authenticated
+      end
+      it "sets oauth token with .configure" do
+        Octokit.configure do |config|
+          config.access_token = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        end
+        expect(Octokit.client).to_not be_basic_authenticated
+        expect(Octokit.client).to be_token_authenticated
+      end
+      it "sets oauth token with module methods" do
+        Octokit.access_token = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        expect(Octokit.client).to_not be_basic_authenticated
+        expect(Octokit.client).to be_token_authenticated
+      end
+      it "sets oauth application creds with .configure" do
+        Octokit.configure do |config|
+          config.client_id     = '97b4937b385eb63d1f46'
+          config.client_secret = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        end
+        expect(Octokit.client).to_not be_basic_authenticated
+        expect(Octokit.client).to_not be_token_authenticated
+        expect(Octokit.client).to be_application_authenticated
+      end
+      it "sets oauth token with module methods" do
+        Octokit.client_id     = '97b4937b385eb63d1f46'
+        Octokit.client_secret = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        expect(Octokit.client).to_not be_basic_authenticated
+        expect(Octokit.client).to_not be_token_authenticated
+        expect(Octokit.client).to be_application_authenticated
+      end
+    end
 
-      expect(Octokit::Client.new(:auto_traversal => true, :per_page => 50).get("https://api.github.com/foo/bar")).to be
+    describe "with class level config" do
+      it "sets basic auth creds with .configure" do
+        @client.configure do |config|
+          config.login = 'pengwynn'
+          config.password = 'il0veruby'
+        end
+        expect(@client).to be_basic_authenticated
+      end
+      it "sets basic auth creds with instance methods" do
+        @client.login = 'pengwynn'
+        @client.password = 'il0veruby'
+        expect(@client).to be_basic_authenticated
+      end
+      it "sets oauth token with .configure" do
+        @client.access_token = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        expect(@client).to_not be_basic_authenticated
+        expect(@client).to be_token_authenticated
+      end
+      it "sets oauth token with instance methods" do
+        @client.access_token = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        expect(@client).to_not be_basic_authenticated
+        expect(@client).to be_token_authenticated
+      end
+      it "sets oauth application creds with .configure" do
+        @client.configure do |config|
+          config.client_id     = '97b4937b385eb63d1f46'
+          config.client_secret = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        end
+        expect(@client).to_not be_basic_authenticated
+        expect(@client).to_not be_token_authenticated
+        expect(@client).to be_application_authenticated
+      end
+      it "sets oauth token with module methods" do
+        @client.client_id     = '97b4937b385eb63d1f46'
+        @client.client_secret = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+        expect(@client).to_not be_basic_authenticated
+        expect(@client).to_not be_token_authenticated
+        expect(@client).to be_application_authenticated
+      end
     end
 
+    describe "when basic authenticated"  do
+      it "makes authenticated calls" do
+        Octokit.configure do |config|
+          config.login = 'pengwynn'
+          config.password = 'il0veruby'
+        end
+
+        VCR.turn_off!
+        root_request = stub_get("https://pengwynn:il0veruby@api.github.com/")
+        Octokit.client.get("/")
+        assert_requested root_request
+        VCR.turn_on!
+      end
+    end
+    describe "when token authenticated", :vcr do
+      it "makes authenticated calls" do
+        client = oauth_client
+
+        root_request = stub_get("/").
+          with(:headers => {:authorization => "token #{test_github_token}"})
+        client.get("/")
+        assert_requested root_request
+      end
+      it "fetches and memoizes login" do
+        client = oauth_client
+
+        expect(client.login).to eq test_github_login
+        assert_requested :get, github_url('/user')
+      end
+    end
+    describe "when application authenticated", :vcr do
+      it "makes authenticated calls" do
+        client = Octokit.client
+        client.client_id     = '97b4937b385eb63d1f46'
+        client.client_secret = 'd255197b4937b385eb63d1f4677e3ffee61fbaea'
+
+        root_request = stub_get("/?client_id=97b4937b385eb63d1f46&client_secret=d255197b4937b385eb63d1f4677e3ffee61fbaea")
+        client.get("/")
+        assert_requested root_request
+      end
+    end
   end
 
-  describe "ratelimit" do
-
-    before(:each) do
-      stub_request(:get, "https://api.github.com/rate_limit").
-        to_return(:status => 200, :body => '', :headers =>
-          { 'X-RateLimit-Limit' => 5000, 'X-RateLimit-Remaining' => 5000})
-      @client = Octokit::Client.new()
+  describe ".agent" do
+    before do
+      Octokit.reset!
     end
-
-    it "gets the ratelimit-limit from the header" do
-      expect(@client.ratelimit).to eq(5000)
+    it "acts like a Sawyer agent" do
+      expect(Octokit.client.agent).to respond_to :start
     end
-
-    it "gets the ratelimit-remaining using header" do
-      expect(@client.ratelimit_remaining).to eq(5000)
+    it "caches the agent" do
+      agent = Octokit.client.agent
+      expect(agent.object_id).to eq Octokit.client.agent.object_id
+    end
+  end # .agent
+
+  describe ".root" do
+    it "fetches the API root" do
+      VCR.use_cassette 'root' do
+        root = Octokit.client.root
+        expect(root.rels[:issues].href).to eq "https://api.github.com/issues"
+      end
     end
-
   end
 
-  describe "unauthed rate limit" do
+  describe ".last_response", :vcr do
+    it "caches the last agent response" do
+      Octokit.reset!
+      client = Octokit.client
+      expect(client.last_response).to be_nil
+      client.get "/"
+      expect(client.last_response.status).to eq 200
+    end
+  end # .last_response
 
+  describe ".get", :vcr do
     before(:each) do
-      Octokit.client_id = "OU812"
-      Octokit.client_secret = "P4N4MA"
-
-      stub_request(:get, "https://api.github.com/rate_limit?client_id=OU812&client_secret=P4N4MA").
-        to_return(:status => 200, :body => '', :headers =>
-          { 'X-RateLimit-Limit' => 62500, 'X-RateLimit-Remaining' => 62500})
-      @client = Octokit::Client.new()
+      Octokit.reset!
     end
-
-    after(:each) do
-      Octokit.reset
+    it "handles query params" do
+      Octokit.get "/", :foo => "bar"
+      assert_requested :get, "https://api.github.com?foo=bar"
     end
-
-    it "gets the ratelimit-limit from the header" do
-      expect(@client.ratelimit).to eq(62500)
+    it "handles headers" do
+      request = stub_get("/zen").
+        with(:query => {:foo => "bar"}, :headers => {:accept => "text/plain"})
+      Octokit.get "/zen", :foo => "bar", :accept => "text/plain"
+      assert_requested request
     end
+  end # .get
 
-    it "gets the ratelimit-remaining using header" do
-      expect(@client.ratelimit_remaining).to eq(62500)
+  describe ".head", :vcr do
+    it "handles query params" do
+      Octokit.reset!
+      Octokit.head "/", :foo => "bar"
+      assert_requested :head, "https://api.github.com?foo=bar"
     end
-
-  end
-
-  describe "api_endpoint" do
-
-    after(:each) do
-      Octokit.reset
+    it "handles headers" do
+      Octokit.reset!
+      request = stub_head("/zen").
+        with(:query => {:foo => "bar"}, :headers => {:accept => "text/plain"})
+      Octokit.head "/zen", :foo => "bar", :accept => "text/plain"
+      assert_requested request
     end
+  end # .head
 
-    it "defaults to https://api.github.com" do
-      client = Octokit::Client.new
-      expect(client.api_endpoint).to eq('https://api.github.com/')
+  describe "when making requests" do
+    before do
+      Octokit.reset!
+      @client = Octokit.client
     end
-
-    it "is set " do
-      Octokit.api_endpoint = 'http://foo.dev'
-      client = Octokit::Client.new
-      expect(client.api_endpoint).to eq('http://foo.dev/')
+    it "Accepts application/vnd.github.beta+json by default" do
+      VCR.use_cassette 'root' do
+        root_request = stub_get("/").
+          with(:headers => {:accept => "application/vnd.github.beta+json"})
+        @client.get "/"
+        assert_requested root_request
+        expect(@client.last_response.status).to eq 200
+      end
     end
-
-  end
-
-  describe "request_host" do
-    after(:each) { Octokit.reset }
-
-    it "defaults to nil" do
-      client = Octokit::Client.new
-      expect(client.request_host).to be_nil
+    it "allows Accept'ing another media type" do
+      root_request = stub_get("/").
+        with(:headers => {:accept => "application/vnd.github.beta.diff+json"})
+      @client.get "/", :accept => "application/vnd.github.beta.diff+json"
+      assert_requested root_request
+      expect(@client.last_response.status).to eq 200
     end
-
-    it "is settable" do
-      Octokit.request_host = 'github.company.com'
-      client = Octokit::Client.new
-      expect(client.request_host).to eq('github.company.com')
+    it "sets a default user agent" do
+      root_request = stub_get("/").
+        with(:headers => {:user_agent => Octokit::Default.user_agent})
+      @client.get "/"
+      assert_requested root_request
+      expect(@client.last_response.status).to eq 200
     end
-
-    it "does not change the Host header when not set" do
-      Octokit.api_endpoint = 'http://github.internal'
-
-      stub_request(:any, /.*/)
-      req = stub_request(:get, 'http://github.internal/users/me').with(:headers => { 'Host' => /.*/})
-      Octokit.user "me"
-      expect(req).not_to have_been_requested
+    it "sets a custom user agent" do
+      user_agent = "Mozilla/5.0 I am Spartacus!"
+      root_request = stub_get("/").
+        with(:headers => {:user_agent => user_agent})
+      client = Octokit::Client.new :user_agent => user_agent
+      client.get "/"
+      assert_requested root_request
+      expect(client.last_response.status).to eq 200
     end
-
-    it "changes the Host header when set" do
-      Octokit.api_endpoint = 'http://github.internal'
-      Octokit.request_host = 'github.company.com'
-
-      req = stub_request(:get, 'http://github.internal/users/me').with(:headers => { 'Host' => 'github.company.com' })
-      Octokit.user "me"
-      expect(req).to have_been_requested
+    it "sets a proxy server" do
+      Octokit.configure do |config|
+        config.proxy = 'http://proxy.example.com:80'
+      end
+      conn = Octokit.client.send(:agent).instance_variable_get(:"@conn")
+      expect(conn.proxy[:uri].to_s).to eq 'http://proxy.example.com'
     end
   end
 
-  describe "endpoint url" do
-
-    it "defaults to api.github.com" do
-      stub_request(:get, 'https://api.github.com').
-        to_return(:body => 'octocat')
-      response = Octokit.get '/'
-      expect(response).to eq('octocat')
+  describe "auto pagination", :vcr do
+    before do
+      Octokit.reset!
+      Octokit.configure do |config|
+        config.auto_paginate = true
+        config.per_page = 3
+      end
     end
 
-    it "can be set in the options" do
-      stub_request(:get, 'http://wynnnetherland.com').
-        to_return(:body => 'pengwynn')
-      response = Octokit.get '/', {:endpoint => 'http://wynnnetherland.com'}
-      expect(response).to eq('pengwynn')
+    after do
+      Octokit.reset!
     end
 
+    it "fetches all the pages" do
+      Octokit.client.paginate('/repos/octokit/octokit.rb/issues')
+      assert_requested :get, github_url("/repos/octokit/octokit.rb/issues?per_page=3")
+      (2..7).each do |i|
+        assert_requested :get, github_url("/repositories/417862/issues?per_page=3&page=#{i}")
+      end
+    end
   end
 
-  describe "error handling" do
+  context "error handling" do
+    before(:each) do
+      Octokit.reset!
+    end
 
-    it "displays validation errors" do
-      stub_patch("https://foo:bar@api.github.com/repos/pengwynn/api-sandbox").
-        to_return(json_response("validation_failed.json"))
+    it "raises on 404", :vcr do
+      expect { Octokit.get('/user') }.to raise_error Octokit::Unauthorized
+    end
 
-      response = Octokit::Client.new(:login => 'foo', :password => 'bar').update_repository('pengwynn/api-sandbox')
-      expect(response.errors.first.message).to eq('name is too short (minimum is 1 characters)')
+    it "raises on 500" do
+      VCR.turn_off!
+      stub_get('/boom').to_return(:status => 500)
+      expect { Octokit.get('/boom') }.to raise_error Octokit::InternalServerError
+      VCR.turn_on!
     end
 
+    it "includes an error message" do
+      stub_get('/boom').
+        to_return(:status => 422, :body => '{"message":"No repository found for hub.topic: https://github.com/joshk/not_existing_project/events/push"}')
+      begin
+        Octokit.get('/boom')
+      rescue Octokit::UnprocessableEntity => e
+        expect(e.message).to include "GET https://api.github.com/boom: 422"
+      end
+    end
   end
 
-
 end