github_api 0.3.2 → 0.3.3

data/features/github_api.feature

@@ -0,0 +1,50 @@
+Feature: Github API components
+
+  In order to interact with full Github API
+  A user needs to request a Github class instance
+
+  Scenario: Accessing repositories API
+    Given I have github instance
+    When  I fetch "repos"
+    Then  I will have access to "Github::Repos" API
+
+  Scenario: Accessing organizations API
+    Given I have github instance
+    When  I fetch "orgs"
+    Then  I will have access to "Github::Orgs" API
+
+  Scenario: Accessing gists API
+    Given I have github instance
+    When  I fetch "gists"
+    Then  I will have access to "Github::Gists" API
+
+  Scenario: Accessing issues API
+    Given I have github instance
+    When  I fetch "issues"
+    Then  I will have access to "Github::Issues" API
+
+  Scenario: Accessing pull requests API
+    Given I have github instance
+    When  I fetch "pull_requests"
+    Then  I will have access to "Github::PullRequests" API
+
+  Scenario: Accessing git data API
+    Given I have github instance
+    When  I fetch "git_data"
+    Then  I will have access to "Github::GitData" API
+
+  Scenario: Accessing users API
+    Given I have github instance
+    When  I fetch "users"
+    Then  I will have access to "Github::Users" API
+
+  Scenario: Accessing users API
+    Given I have github instance
+    When  I fetch "events"
+    Then  I will have access to "Github::Events" API
+
+  Scenario: Accessing authorizations API
+    Given I have github instance
+    When  I fetch "oauth"
+    Then  I will have access to "Github::Authorizations" API
+

data/features/step_definitions/github_api_steps.rb

@@ -0,0 +1,11 @@
+Given /^I have github instance$/ do
+  @github = Github.new
+end
+
+When /^I fetch "([^"]*)"$/ do |method|
+  @response = @github.send(method.to_sym)
+end
+
+When /^I will have access to "([^"]*)" API$/ do |api|
+  @response.class.to_s.should match api
+end

data/features/support/env.rb

@@ -8,6 +8,6 @@ rescue Bundler::BundlerError => e
 end
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'github'
+require 'github_api'
 
 require 'rspec/expectations'

data/lib/github_api.rb

@@ -25,6 +25,7 @@ module Github
     def respond_to?(method, include_private = false)
       new.respond_to?(method, include_private) || super(method, include_private)
     end
+
   end
 
   module AutoloadHelper
@@ -34,6 +35,17 @@ module Github
         autoload const_name, File.join(prefix, path)
       end
     end
+
+    def register_constant(options)
+      options.each do |const_name, value|
+        const_set const_name.upcase.to_s, value
+      end
+    end
+
+    def lookup_constant(const_name)
+      const_get const_name.upcase.to_s
+    end
+
   end
 
   extend AutoloadHelper
@@ -44,6 +56,7 @@ module Github
     :Repos        => 'repos',
     :Request      => 'request',
     :Response     => 'response',
+    :Result       => 'result',
     :Error        => 'error',
     :Issues       => 'issues',
     :Gists        => 'gists',

data/lib/github_api/connection.rb

@@ -4,6 +4,7 @@ require 'faraday'
 require 'github_api/response'
 require 'github_api/response/mashify'
 require 'github_api/response/jsonize'
+require 'github_api/response/helpers'
 require 'github_api/response/raise_error'
 require 'github_api/request/oauth2'
 require 'github_api/request/basic_auth'
@@ -58,6 +59,7 @@ module Github
           builder.use Github::Request::OAuth2, oauth_token if oauth_token?
           builder.use Github::Request::BasicAuth, authentication if basic_authed?
 
+          builder.use Github::Response::Helpers
           unless options[:raw]
             builder.use Github::Response::Mashify
             builder.use Github::Response::Jsonize

data/lib/github_api/response.rb

@@ -6,5 +6,23 @@ module Github
   # Contains methods and attributes that act on the response returned from the 
   # request
   class Response < Faraday::Response::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+
+    class << self
+      attr_accessor :parser
+    end
+
+    def self.define_parser(&block)
+      @parser = block
+    end
+
+    def response_type(env)
+      env[:response_headers][CONTENT_TYPE].to_s
+    end
+
+    def parse_response?(env)
+      env[:body].respond_to? :to_str
+    end
+
   end # Response
-end
+end # Github

data/lib/github_api/response/helpers.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Response::Helpers < Response
+
+    def on_complete(env)
+      env[:body].extend(Github::Result)
+      env[:body].instance_eval { @env = env }
+    end
+
+  end # Response::Helpers
+end # Github

data/lib/github_api/response/jsonize.rb

@@ -3,9 +3,13 @@
 require 'faraday'
 
 module Github
-  class Response::Jsonize < Faraday::Response::Middleware
+  class Response::Jsonize < Response
     dependency 'multi_json'
 
+    define_parser do |body|
+      ::MultiJson.decode body
+    end
+
     def parse(body)
       case body
       when ''
@@ -15,8 +19,8 @@ module Github
       when 'false'
         false
       else
-        ::MultiJson.decode(body)
+        self.class.parser.call body
       end
     end
-  end
+  end # Response::Jsonize
 end # Github

data/lib/github_api/response/mashify.rb

@@ -3,24 +3,22 @@
 require 'faraday'
 
 module Github
-  class Response::Mashify < Faraday::Response::Middleware
+  class Response::Mashify < Response
     dependency 'hashie/mash'
 
-    class << self
-      attr_accessor :mash_class
+    define_parser do |body|
+      ::Hashie::Mash.new body
     end
 
-    self.mash_class = ::Hashie::Mash
-
     def parse(body)
       case body
       when Hash
-        self.class.mash_class.new(body)
+        self.class.parser.call body
       when Array
-        body.map { |item| item.is_a?(Hash) ? self.class.mash_class.new(item) : item }
+        body.map { |item| item.is_a?(Hash) ? self.class.parser.call(item) : item }
       else
         body
       end
     end
-  end
+  end # Response::Mashify
 end # Github

data/lib/github_api/result.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Github
+  module Result
+
+    RATELIMIT = 'X-RateLimit-Remaining'.freeze
+    CONTENT_TYPE = 'Content-Type'.freeze
+    CONTENT_LENGTH = 'content-length'.freeze
+
+    attr_reader :env
+
+    # Requests are limited to API v3 to 5000 per hour.
+    def ratelimit
+      loaded? ? @env[:response_headers][RATELIMIT] : nil
+    end
+
+    def content_type
+      loaded? ? @env[:response_headers][CONTENT_TYPE] : nil
+    end
+
+    def content_length
+      loaded? ? @env[:response_headers][CONTENT_LENGTH] : nil
+    end
+
+    def status
+      loaded? ? @env[:status] : nil
+    end
+
+    def success?
+      (200..299).include? status
+    end
+
+    def body
+      loaded? ? @env[:body] : nil
+    end
+
+    def loaded?
+      !!env
+    end
+
+  end # Result
+end # Github

data/lib/github_api/users.rb

@@ -44,11 +44,12 @@ module Github
     def get_user(user_name=nil, params={})
       _normalize_params_keys(params)
       if user_name
-        get("/users/#{user}", params)
+        get("/users/#{user_name}", params)
       else
         get("/user", params)
       end
     end
+    alias :get_auth_user :get_user
 
     # Update the authenticated user
     #
@@ -77,6 +78,7 @@ module Github
       _filter_params_keys(VALID_USER_PARAMS_NAMES, params)
       patch("/user", params)
     end
+    alias :update_authenticated_user :update_user
 
   end # Users
 end # Github

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 3
-    PATCH = 2
+    PATCH = 3
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/fixtures/users/user.json

@@ -0,0 +1,32 @@
+{
+  "login": "octocat",
+  "id": 1,
+  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+  "gravatar_id": "somehexcode",
+  "url": "https://api.github.com/users/octocat",
+  "name": "monalisa octocat",
+  "company": "GitHub",
+  "blog": "https://github.com/blog",
+  "location": "San Francisco",
+  "email": "octocat@github.com",
+  "hireable": false,
+  "bio": "There once was...",
+  "public_repos": 2,
+  "public_gists": 1,
+  "followers": 20,
+  "following": 0,
+  "html_url": "https://github.com/octocat",
+  "created_at": "2008-01-14T04:33:35Z",
+  "type": "User",
+  "total_private_repos": 100,
+  "owned_private_repos": 100,
+  "private_gists": 81,
+  "disk_usage": 10000,
+  "collaborators": 8,
+  "plan": {
+    "name": "Medium",
+    "space": 400,
+    "collaborators": 10,
+    "private_repos": 20
+  }
+}

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 2
-  version: 0.3.2
+  - 3
+  version: 0.3.3
 platform: ruby
 authors: 
 - Piotr Murach
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-03 00:00:00 +00:00
+date: 2011-12-04 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -180,6 +180,18 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: guard-cucumber
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id013
 description: " Ruby wrapper that supports all of the GitHub API v3 methods(nearly 200). It's build in a modular way, that is, you can either instantiate the whole api wrapper Github.new or use parts of it e.i. Github::Repos.new if working solely with repositories is your main concern. "
 email: ""
 executables: []
@@ -190,8 +202,8 @@ extra_rdoc_files: []
 
 files: 
 - Rakefile
-- features/github.feature
-- features/step_definitions/github_steps.rb
+- features/github_api.feature
+- features/step_definitions/github_api_steps.rb
 - features/support/env.rb
 - lib/github_api/api/utils.rb
 - lib/github_api/api.rb
@@ -238,10 +250,12 @@ files:
 - 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
@@ -281,6 +295,7 @@ files:
 - 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
@@ -313,6 +328,8 @@ files:
 - 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/spec_helper.rb
 - README.rdoc

data/features/github.feature

@@ -1,9 +0,0 @@
-Feature: something something
-  In order to something something
-  A user something something
-  something something something
-
-  Scenario: something something
-    Given inspiration
-    When I create a sweet new gem
-    Then everyone should see how awesome I am