github_api 0.3.5 → 0.3.6

data/spec/github/result_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Github::Result do
+
+  let(:github) { Github.new }
+  let(:res)    { github.events.public }
+
+  before do
+    stub_get("/events").
+      to_return(:body => fixture('events/events.json'),
+        :status => 200,
+        :headers => {
+          :content_type => "application/json; charset=utf-8",
+          'X-RateLimit-Remaining' => '4999',
+          'content-length' => '344'
+        })
+  end
+
+  it "should read response content_type " do
+    res.content_type.should match 'application/json'
+  end
+
+  it "should read response content_length " do
+    res.content_length.should match '344'
+  end
+
+  it "should read response ratelimit" do
+    res.ratelimit.should == '4999'
+  end
+
+  it "should read response statsu" do
+    res.status.should be 200
+  end
+
+  it "should assess successful" do
+    res.success?.should be_true
+  end
+
+  it "should read response body" do
+    res.body.should_not be_empty
+  end
+
+end # Github::Result

data/spec/github/users_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+
+describe Github::Users do
+
+  let(:github) { Github.new }
+  let(:user)   { 'peter-murach' }
+
+  before do
+    reset_authentication_for github
+  end
+
+  after do
+    reset_authentication_for github
+  end
+
+  describe "get_user" do
+    context "resource found for a user" do
+      before do
+        stub_get("/users/#{user}").
+          to_return(:body => fixture('users/user.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      it "should get the resources" do
+        github.users.get_user user
+        a_get("/users/#{user}").should have_been_made
+      end
+
+      it "should return resource" do
+        user_resource = github.users.get_user user
+        user_resource.should be_a Hash
+      end
+
+      it "should be a mash type" do
+        user_resource = github.users.get_user user
+        user_resource.should be_a Hashie::Mash
+      end
+
+      it "should get org information" do
+        user_resource = github.users.get_user user
+        user_resource.login.should == 'octocat'
+      end
+
+      it "should yield to a block" do
+        github.users.should_receive(:get_user).with(user).and_yield('web')
+        github.users.get_user(user) { |param| 'web' }
+      end
+    end
+
+    context "resource found for an authenticated user" do
+      before do
+        reset_authentication_for github
+        github.oauth_token = OAUTH_TOKEN
+        stub_get("/user?access_token=#{OAUTH_TOKEN}").
+          to_return(:body => fixture('users/user.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+      end
+
+      after do
+        reset_authentication_for github
+      end
+
+      it "should get the resources" do
+        github.users.get_user
+        a_get("/user?access_token=#{OAUTH_TOKEN}").should have_been_made
+      end
+    end
+
+    context "resource not found for a user" do
+      before do
+        stub_get("/users/#{user}").
+          to_return(:body => "", :status => [404, "Not Found"])
+      end
+
+      it "should return 404 with a message 'Not Found'" do
+        expect {
+          github.users.get_user user
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # get_user
+
+  describe "update_user" do
+    let(:user_params) {
+      {
+        "name" => "monalisa octocat",
+        "email" => "octocat@github.com",
+        "blog" => "https://github.com/blog",
+        "company" => "GitHub",
+        "location" => "San Francisco",
+        "hireable" => true,
+        "bio" => "There once..."
+      }
+    }
+
+    context "resouce updated" do
+      before do
+        reset_authentication_for github
+        github.oauth_token = OAUTH_TOKEN
+        stub_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).
+          to_return(:body => fixture('users/user.json'), :status => 200, :headers => {:content_type => "application/json; charset=utf-8"})
+
+      end
+
+      after do
+        reset_authentication_for github
+      end
+
+      it "should create resource successfully" do
+        github.users.update_user
+        a_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).should have_been_made
+      end
+
+      it "should return the resource" do
+        user_resource = github.users.update_user
+        user_resource.should be_a Hashie::Mash
+      end
+
+      it "should get the resource information" do
+        user_resource = github.users.update_user
+        user_resource.login.should == 'octocat'
+      end
+    end
+
+    context "failed to update resource" do
+      before do
+        reset_authentication_for github
+        github.oauth_token = OAUTH_TOKEN
+        stub_patch("/user?access_token=#{OAUTH_TOKEN}").with(user_params).
+          to_return(:body => fixture('users/user.json'), :status => 404, :headers => {:content_type => "application/json; charset=utf-8"})
+
+      end
+
+      it "should fail to retrieve resource" do
+        expect {
+          github.users.update_user
+        }.to raise_error(Github::ResourceNotFound)
+      end
+    end
+  end # update_comment
+
+end # Github::Users

data/spec/github_spec.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Github do
+
+  before do
+    Github.user = nil
+    Github.repo = nil
+  end
+
+  it "should respond to 'new' message" do
+    Github.should respond_to :new
+  end
+
+  it "should receive 'new' and initialize Github::Client instance" do
+    Github.new.should be_a Github::Client
+  end
+
+  it "should respond to 'configure' message" do
+    Github.should respond_to :configure
+  end
+
+  describe "setting configuration options" do
+
+    it "should return default adapter" do
+      Github.adapter.should == Github::Configuration::DEFAULT_ADAPTER
+    end
+
+    it "should allow to set adapter" do
+      Github.adapter = :typhoeus
+      Github.adapter.should == :typhoeus
+    end
+
+    it "should return the default end point" do
+      Github.endpoint.should == Github::Configuration::DEFAULT_ENDPOINT
+    end
+
+    it "should allow to set endpoint" do
+      Github.endpoint = 'http://linkedin.com'
+      Github.endpoint.should == 'http://linkedin.com'
+    end
+
+    it "should return the default user agent" do
+      Github.user_agent.should == Github::Configuration::DEFAULT_USER_AGENT
+    end
+
+    it "should allow to set new user agent" do
+      Github.user_agent = 'New User Agent'
+      Github.user_agent.should == 'New User Agent'
+    end
+
+    it "should have not set oauth token" do
+      Github.oauth_token.should be_nil
+    end
+
+    it "should allow to set oauth token" do
+      Github.oauth_token = ''
+    end
+
+    it "should have not set default user" do
+      Github.user.should be_nil
+    end
+
+    it "should allow to set new user" do
+      Github.user = 'github'
+      Github.user.should == 'github'
+    end
+
+    it "should have not set default repository" do
+      Github.repo.should be_nil
+    end
+
+    it "should allow to set new repository" do
+      Github.repo = 'github'
+      Github.repo.should == 'github'
+    end
+
+    it "should have connection options as hash" do
+      Github.connection_options.should be_a Hash
+    end
+
+    it "should initialize connection options to empty hash" do
+      Github.connection_options.should be_empty
+    end
+
+    it "shoulve have not set user's login" do
+      Github.login.should be_nil
+    end
+
+    it "should have not set user's password" do
+      Github.password.should be_nil
+    end
+
+    it "should have set mime type to json" do
+      Github.mime_type.should == :json
+    end
+  end
+
+  describe ".configure" do
+    Github::Configuration::VALID_OPTIONS_KEYS.each do |key|
+      it "should set the #{key}" do
+        Github.configure do |config|
+          config.send("#{key}=", key)
+          Github.send(key).should == key
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'json'
+require 'webmock/rspec'
+require 'github_api'
+
+if RUBY_VERSION > '1.9' and ENV['COVERAGE']
+  require 'coverage_adapter'
+  SimpleCov.start 'github_api'
+end
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.include WebMock::API
+end
+
+def stub_get(path, endpoint = Github.endpoint.to_s)
+  stub_request(:get, endpoint + path)
+end
+
+def stub_post(path, endpoint = Github.endpoint.to_s)
+  stub_request(:post, endpoint + path)
+end
+
+def stub_patch(path, endpoint = Github.endpoint.to_s)
+  stub_request(:patch, endpoint + path)
+end
+
+def stub_put(path, endpoint = Github.endpoint.to_s)
+  stub_request(:put, endpoint + path)
+end
+
+def stub_delete(path, endpoint = Github.endpoint.to_s)
+  stub_request(:delete, endpoint + path)
+end
+
+def a_get(path, endpoint = Github.endpoint.to_s)
+  a_request(:get, endpoint + path)
+end
+
+def a_post(path, endpoint = Github.endpoint.to_s)
+  a_request(:post, endpoint + path)
+end
+
+def a_patch(path, endpoint = Github.endpoint.to_s)
+  a_request(:patch, endpoint + path)
+end
+
+def a_put(path, endpoint = Github.endpoint)
+  a_request(:put, endpoint + path)
+end
+
+def a_delete(path, endpoint = Github.endpoint)
+  a_request(:delete, endpoint + path)
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(File.join(fixture_path, '/', file))
+end
+
+OAUTH_TOKEN = 'bafec72922f31fe86aacc8aca4261117f3bd62cf'
+
+def reset_authentication_for(object)
+  ['basic_auth', 'oauth_token', 'login', 'password' ].each do |item|
+    object.send("#{item}=", nil)
+  end
+end
+
+class Hash
+  def except(*keys)
+    cpy = self.dup
+    keys.each { |key| cpy.delete(key) }
+    cpy
+  end
+end

data/spec/support/base.rb

@@ -0,0 +1,13 @@
+module SpecHelpers
+  module Base
+
+    def self.included(base)
+      base.class_eval do
+        let(:github) { Github.new }
+        let(:user)   { 'peter-murach' }
+        let(:repo)   { 'github' }
+      end
+    end
+
+  end
+end # SpecHelpers

metadata

@@ -2,7 +2,7 @@
 name: github_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors: 
 - Piotr Murach
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-18 00:00:00 +00:00
+date: 2011-12-26 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -164,8 +164,153 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- Rakefile
+- features/github_api.feature
+- features/options.feature
+- features/pagination.feature
+- features/step_definitions/github_api_steps.rb
+- features/support/env.rb
+- lib/github_api/api/utils.rb
+- lib/github_api/api.rb
+- lib/github_api/authorization.rb
+- lib/github_api/authorizations.rb
+- lib/github_api/cache_control.rb
+- lib/github_api/client.rb
+- lib/github_api/compatibility.rb
+- lib/github_api/configuration.rb
+- lib/github_api/connection.rb
+- lib/github_api/core_ext/array.rb
+- lib/github_api/core_ext/hash.rb
+- lib/github_api/error.rb
+- lib/github_api/events.rb
+- lib/github_api/gists/comments.rb
+- lib/github_api/gists.rb
+- lib/github_api/git_data/blobs.rb
+- lib/github_api/git_data/commits.rb
+- lib/github_api/git_data/references.rb
+- lib/github_api/git_data/tags.rb
+- lib/github_api/git_data/trees.rb
+- lib/github_api/git_data.rb
+- lib/github_api/issues/comments.rb
+- lib/github_api/issues/events.rb
+- lib/github_api/issues/labels.rb
+- lib/github_api/issues/milestones.rb
+- lib/github_api/issues.rb
+- lib/github_api/mime_type.rb
+- lib/github_api/orgs/members.rb
+- lib/github_api/orgs/teams.rb
+- lib/github_api/orgs.rb
+- lib/github_api/pull_requests/comments.rb
+- lib/github_api/pull_requests.rb
+- lib/github_api/repos/collaborators.rb
+- lib/github_api/repos/commits.rb
+- lib/github_api/repos/downloads.rb
+- lib/github_api/repos/forks.rb
+- lib/github_api/repos/hooks.rb
+- lib/github_api/repos/keys.rb
+- lib/github_api/repos/pub_sub_hubbub.rb
+- lib/github_api/repos/watching.rb
+- lib/github_api/repos.rb
+- lib/github_api/request/basic_auth.rb
+- lib/github_api/request/caching.rb
+- lib/github_api/request/oauth2.rb
+- lib/github_api/request.rb
+- lib/github_api/response/helpers.rb
+- lib/github_api/response/jsonize.rb
+- lib/github_api/response/mashify.rb
+- lib/github_api/response/raise_error.rb
+- lib/github_api/response.rb
+- lib/github_api/result.rb
+- lib/github_api/users/emails.rb
+- lib/github_api/users/followers.rb
+- lib/github_api/users/keys.rb
+- lib/github_api/users.rb
+- lib/github_api/version.rb
+- lib/github_api.rb
+- spec/coverage_adapter.rb
+- spec/fixtures/auths/authorization.json
+- spec/fixtures/auths/authorizations.json
+- spec/fixtures/events/events.json
+- spec/fixtures/issues/comment.json
+- spec/fixtures/issues/comments.json
+- spec/fixtures/issues/event.json
+- spec/fixtures/issues/events.json
+- spec/fixtures/issues/issue.json
+- spec/fixtures/issues/issues.json
+- spec/fixtures/issues/milestone.json
+- spec/fixtures/issues/milestones.json
+- spec/fixtures/orgs/members.json
+- spec/fixtures/orgs/org.json
+- spec/fixtures/orgs/orgs.json
+- spec/fixtures/orgs/team.json
+- spec/fixtures/orgs/team_repos.json
+- spec/fixtures/orgs/teams.json
+- spec/fixtures/repos/branches.json
+- spec/fixtures/repos/collaborators.json
+- spec/fixtures/repos/commit.json
+- spec/fixtures/repos/commit_comment.json
+- spec/fixtures/repos/commit_comments.json
+- spec/fixtures/repos/commits.json
+- spec/fixtures/repos/contributors.json
+- spec/fixtures/repos/download.json
+- spec/fixtures/repos/download_s3.json
+- spec/fixtures/repos/downloads.json
+- spec/fixtures/repos/fork.json
+- spec/fixtures/repos/forks.json
+- spec/fixtures/repos/hook.json
+- spec/fixtures/repos/hooks.json
+- spec/fixtures/repos/key.json
+- spec/fixtures/repos/keys.json
+- spec/fixtures/repos/languages.json
+- spec/fixtures/repos/repo.json
+- spec/fixtures/repos/repo_comments.json
+- spec/fixtures/repos/repos.json
+- spec/fixtures/repos/tags.json
+- spec/fixtures/repos/teams.json
+- spec/fixtures/repos/watched.json
+- spec/fixtures/repos/watchers.json
+- spec/fixtures/users/user.json
+- spec/github/api_spec.rb
+- spec/github/authorization_spec.rb
+- spec/github/authorizations_spec.rb
+- spec/github/client_spec.rb
+- spec/github/core_ext/hash_spec.rb
+- spec/github/events_spec.rb
+- spec/github/gists/comments_spec.rb
+- spec/github/gists_spec.rb
+- spec/github/git_data/blobs_spec.rb
+- spec/github/git_data/commits_spec.rb
+- spec/github/git_data/references_spec.rb
+- spec/github/git_data/tags_spec.rb
+- spec/github/git_data/trees_spec.rb
+- spec/github/git_data_spec.rb
+- spec/github/issues/comments_spec.rb
+- spec/github/issues/events_spec.rb
+- spec/github/issues/labels_spec.rb
+- spec/github/issues/milestones_spec.rb
+- spec/github/issues_spec.rb
+- spec/github/mime_type_spec.rb
+- spec/github/orgs/members_spec.rb
+- spec/github/orgs/teams_spec.rb
+- spec/github/orgs_spec.rb
+- spec/github/repos/collaborators_spec.rb
+- spec/github/repos/commits_spec.rb
+- spec/github/repos/downloads_spec.rb
+- spec/github/repos/forks_spec.rb
+- spec/github/repos/hooks_spec.rb
+- spec/github/repos/keys_spec.rb
+- spec/github/repos/pub_sub_hubbub_spec.rb
+- spec/github/repos/watching_spec.rb
+- spec/github/repos_spec.rb
+- spec/github/result_spec.rb
+- spec/github/users_spec.rb
+- spec/github_spec.rb
+- spec/README.rdoc
+- spec/spec_helper.rb
+- spec/support/base.rb
+- README.rdoc
+- LICENSE.txt
 has_rdoc: true
 homepage: https://github.com/peter-murach/github
 licenses: []