github_api 0.8.0 → 0.8.1

data/features/gists/comments.feature

@@ -15,11 +15,11 @@ Feature: Accessing Gists Comments API
       And the response type should be JSON
       And the response should have 18 items
 
-  Scenario: Gets a single gist's comment
-    When I want to get resource with the following params:
-      | comment_id |
-      | 33469      |
-    And I make request within a cassette named "gists/comments/first"
-    Then the response status should be 200
-      And the response type should be JSON
-      And the response should not be empty
+#   Scenario: Gets a single gist's comment
+#     When I want to get resource with the following params:
+#       | gist_id | comment_id |
+#       | 999390  | 33663      |
+#     And I make request within a cassette named "gists/comments/first"
+#     Then the response status should be 200
+#       And the response type should be JSON
+#       And the response should not be empty

data/lib/github_api/gists/comments.rb

@@ -3,11 +3,11 @@
 module Github
   class Gists::Comments < API
 
-    REQUIRED_GIST_COMMENT_INPUTS = %w[
+    REQUIRED_GIST_COMMENT_OPTIONS = %w[
       body
     ].freeze
 
-    ALLOWED_GIST_COMMENT_INPUTS = %w[
+    VALID_GIST_COMMENT_OPTIONS = %w[
       body
       mime_type
       resource
@@ -34,14 +34,14 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.gists.comments.get 'comment-id'
+    #  github.gists.comments.get 'gist-id', 'comment-id'
     #
-    def get(comment_id, params={})
+    def get(gist_id, comment_id, params={})
       normalize! params
       assert_presence_of comment_id
       # _merge_mime_type(:gist_comment, params)
 
-      get_request("/gists/comments/#{comment_id}", params)
+      get_request("/gists/#{gist_id}/comments/#{comment_id}", params)
     end
     alias :find :get
 
@@ -54,8 +54,8 @@ module Github
     def create(gist_id, params={})
       normalize! params
       # _merge_mime_type(:gist_comment, params)
-      filter! ALLOWED_GIST_COMMENT_INPUTS, params
-      assert_required_keys(REQUIRED_GIST_COMMENT_INPUTS, params)
+      filter! VALID_GIST_COMMENT_OPTIONS, params
+      assert_required_keys(REQUIRED_GIST_COMMENT_OPTIONS, params)
 
       post_request("/gists/#{gist_id}/comments", params)
     end
@@ -64,30 +64,30 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.gists.comments.edit 'comment-id'
+    #  github.gists.comments.edit 'gist-id', 'comment-id'
     #
-    def edit(comment_id, params={})
+    def edit(gist_id, comment_id, params={})
       normalize! params
       assert_presence_of comment_id
       # _merge_mime_type(:gist_comment, params)
-      filter! ALLOWED_GIST_COMMENT_INPUTS, params
-      assert_required_keys(REQUIRED_GIST_COMMENT_INPUTS, params)
+      filter! VALID_GIST_COMMENT_OPTIONS, params
+      assert_required_keys(REQUIRED_GIST_COMMENT_OPTIONS, params)
 
-      patch_request("/gists/comments/#{comment_id}", params)
+      patch_request("/gists/#{gist_id}/comments/#{comment_id}", params)
     end
 
     # Delete a comment
     #
     # = Examples
     #  github = Github.new
-    #  github.gists.comments.delete 'comment-id'
+    #  github.gists.comments.delete 'gist-id', 'comment-id'
     #
-    def delete(comment_id, params={})
+    def delete(gist_id, comment_id, params={})
       normalize! params
       assert_presence_of comment_id
       # _merge_mime_type(:gist_comment, params)
 
-      delete_request("/gists/comments/#{comment_id}", params)
+      delete_request("/gists/#{gist_id}/comments/#{comment_id}", params)
     end
 
   end # Gists::Comments

data/lib/github_api/repos.rb

@@ -35,6 +35,8 @@ module Github
       has_wiki
       has_downloads
       team_id
+      auto_init
+      gitignore_template
     ].freeze
 
     VALID_REPO_TYPES = %w[ all public private member ].freeze
@@ -193,7 +195,7 @@ module Github
       assert_presence_of user, repo
       normalize! params
 
-      delete_request("/repos/#{user}/#{repo}")
+      delete_request("/repos/#{user}/#{repo}", params)
     end
     alias :remove :delete
 

data/lib/github_api/repos/comments.rb

@@ -3,9 +3,10 @@
 module Github
   class Repos::Comments < API
 
-    REQUIRED_COMMENT_PARAMS = %w[
+    REQUIRED_COMMENT_OPTIONS = %w[ body ].freeze
+
+    VALID_COMMENT_OPTIONS = %w[
       body
-      commit_id
       line
       path
       position
@@ -77,9 +78,9 @@ module Github
       assert_presence_of user, repo, sha
 
       normalize! params
-      filter! REQUIRED_COMMENT_PARAMS, params
+      filter! VALID_COMMENT_OPTIONS, params
 
-      assert_required_keys(REQUIRED_COMMENT_PARAMS, params)
+      assert_required_keys(REQUIRED_COMMENT_OPTIONS, params)
 
       post_request("/repos/#{user}/#{repo}/commits/#{sha}/comments", params)
     end
@@ -98,7 +99,7 @@ module Github
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, comment_id
       normalize! params
-      assert_required_keys(%w[ body ], params)
+      assert_required_keys(REQUIRED_COMMENT_OPTIONS, params)
 
       patch_request("/repos/#{user}/#{repo}/comments/#{comment_id}", params)
     end

data/lib/github_api/requestable.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+module Github
+  # Defines HTTP verbs
+  module Request
+
+    METHODS = [:get, :post, :put, :delete, :patch]
+    METHODS_WITH_BODIES = [ :post, :put, :patch ]
+
+    def get_request(path, params={}, options={})
+      request(:get, path, params, options)
+    end
+
+    def patch_request(path, params={}, options={})
+      request(:patch, path, params, options)
+    end
+
+    def post_request(path, params={}, options={})
+      request(:post, path, params, options)
+    end
+
+    def put_request(path, params={}, options={})
+      request(:put, path, params, options)
+    end
+
+    def delete_request(path, params={}, options={})
+      request(:delete, path, params, options)
+    end
+
+    def request(method, path, params, options)
+      if !METHODS.include?(method)
+        raise ArgumentError, "unkown http method: #{method}"
+      end
+      # _extract_mime_type(params, options)
+
+      puts "EXECUTED: #{method} - #{path} with #{params} and #{options}" if ENV['DEBUG']
+
+      conn = connection(options)
+      path = (conn.path_prefix + path).gsub(/\/\//,'/') if conn.path_prefix != '/'
+
+      response = conn.send(method) do |request|
+        case method.to_sym
+        when *(METHODS - METHODS_WITH_BODIES)
+          request.body = params.delete('data') if params.has_key?('data')
+          request.url(path, params)
+        when *METHODS_WITH_BODIES
+          request.path = path
+          request.body = extract_data_from_params(params) unless params.empty?
+        end
+      end
+      response.body
+    end
+
+    private
+
+    def extract_data_from_params(params) # :nodoc:
+      return params['data'] if params.has_key?('data') and !params['data'].nil?
+      return params
+    end
+
+    def _extract_mime_type(params, options) # :nodoc:
+      options['resource']  = params['resource'] ? params.delete('resource') : ''
+      options['mime_type'] = params['resource'] ? params.delete('mime_type') : ''
+    end
+
+  end # Request
+end # Github

data/lib/github_api/version.rb

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

data/spec/github/activity/activity_spec.rb

@@ -6,6 +6,8 @@ describe Github::Activity, 'integration' do
 
   after { reset_authentication_for subject }
 
+  it_should_behave_like 'api interface'
+
   its(:events)        { should be_a Github::Activity::Events }
 
   its(:notifications) { should be_a Github::Activity::Notifications }

data/spec/github/activity/events/issue_spec.rb

@@ -28,15 +28,8 @@ describe Github::Activity::Events, '#issue' do
       a_get(request_path).should have_been_made
     end
 
-    it "should return array of resources" do
-      events = subject.issue user, repo
-      events.should be_an Array
-      events.should have(1).items
-    end
-
-    it "should be a mash type" do
-      events = subject.issue user, repo
-      events.first.should be_a Hashie::Mash
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.issue user, repo }
     end
 
     it "should get event information" do
@@ -45,19 +38,14 @@ describe Github::Activity::Events, '#issue' do
     end
 
     it "should yield to a block" do
-      subject.should_receive(:issue).with(user, repo).and_yield('web')
-      subject.issue(user, repo) { |param| 'web' }
+      yielded = []
+      result = subject.issue(user, repo) { |obj| yielded << obj }
+      yielded.should == result
     end
   end
 
-  context "resource not found" do
-    let(:body) { '' }
-    let(:status) { [404, "Not Found"] }
-
-    it "should return 404 with a message 'Not Found'" do
-      expect {
-        subject.issue user, repo
-      }.to raise_error(Github::Error::NotFound)
-    end
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.issue user, repo }
   end
+
 end # issue

data/spec/github/activity/events/network_spec.rb

@@ -26,15 +26,8 @@ describe Github::Activity::Events, '#network' do
       a_get(request_path).should have_been_made
     end
 
-    it "should return array of resources" do
-      events = subject.network user, repo
-      events.should be_an Array
-      events.should have(1).items
-    end
-
-    it "should be a mash type" do
-      events = subject.network user, repo
-      events.first.should be_a Hashie::Mash
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.network user, repo }
     end
 
     it "should get event information" do
@@ -43,19 +36,14 @@ describe Github::Activity::Events, '#network' do
     end
 
     it "should yield to a block" do
-      subject.should_receive(:network).with(user, repo).and_yield('web')
-      subject.network(user, repo) { |param| 'web' }
+      yielded = []
+      result = subject.network(user, repo) { |obj| yielded << obj }
+      yielded.should == result
     end
   end
 
-  context "resource not found" do
-    let(:body) { '' }
-    let(:status) { [404, "Not Found"] }
-
-    it "should return 404 with a message 'Not Found'" do
-      expect {
-        subject.network user, repo
-      }.to raise_error(Github::Error::NotFound)
-    end
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.network user, repo }
   end
+
 end # network

data/spec/github/activity/events/org_spec.rb

@@ -27,15 +27,8 @@ describe Github::Activity::Events, '#org' do
       a_get(request_path).should have_been_made
     end
 
-    it "should return array of resources" do
-      events = subject.org org
-      events.should be_an Array
-      events.should have(1).items
-    end
-
-    it "should be a mash type" do
-      events = subject.org org
-      events.first.should be_a Hashie::Mash
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.org org }
     end
 
     it "should get event information" do
@@ -44,17 +37,14 @@ describe Github::Activity::Events, '#org' do
     end
 
     it "should yield to a block" do
-      subject.should_receive(:org).with(org).and_yield('web')
-      subject.org(org) { |param| 'web' }
+      yielded = []
+      result = subject.org(org) { |obj| yielded << obj }
+      yielded.should == result
     end
   end
 
-  context "resource not found" do
-    let(:body) { '' }
-    let(:status) { [404, "Not Found"] }
-
-    it "should return 404 with a message 'Not Found'" do
-      expect { subject.org org }.to raise_error(Github::Error::NotFound)
-    end
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.org org }
   end
+
 end # org

data/spec/github/activity/events/performed_spec.rb

@@ -26,15 +26,8 @@ describe Github::Activity::Events, '#performed' do
       a_get(request_path).should have_been_made
     end
 
-    it "should return array of resources" do
-      events = subject.performed user
-      events.should be_an Array
-      events.should have(1).items
-    end
-
-    it "should be a mash type" do
-      events = subject.performed user
-      events.first.should be_a Hashie::Mash
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.performed user }
     end
 
     it "should get event information" do
@@ -43,8 +36,9 @@ describe Github::Activity::Events, '#performed' do
     end
 
     it "should yield to a block" do
-      subject.should_receive(:performed).with(user).and_yield('web')
-      subject.performed(user) { |param| 'web' }
+      yielded = []
+      result = subject.performed(user) { |obj| yielded << obj }
+      yielded.should == result
     end
   end
 
@@ -56,15 +50,8 @@ describe Github::Activity::Events, '#performed' do
       a_get(request_path).should have_been_made
     end
 
-    it "should return array of resources" do
-      events = subject.performed user, :public => true
-      events.should be_an Array
-      events.should have(1).items
-    end
-
-    it "should be a mash type" do
-      events = subject.performed user, :public => true
-      events.first.should be_a Hashie::Mash
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.performed user, :public => true }
     end
 
     it "should get event information" do
@@ -73,19 +60,14 @@ describe Github::Activity::Events, '#performed' do
     end
 
     it "should yield to a block" do
-      subject.should_receive(:performed).with(user).and_yield('web')
-      subject.performed(user) { |param| 'web' }
+      yielded = []
+      result = subject.performed(user, :public => true) { |obj| yielded << obj }
+      yielded.should == result
     end
   end
 
-  context "resource not found" do
-    let(:body) { '' }
-    let(:status) { [404, "Not Found"] }
-
-    it "should return 404 with a message 'Not Found'" do
-      expect {
-        subject.performed user
-      }.to raise_error(Github::Error::NotFound)
-    end
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.performed user }
   end
+
 end # performed

data/spec/github/activity/events/public_spec.rb

@@ -21,15 +21,8 @@ describe Github::Activity::Events, '#public' do
       a_get(request_path).should have_been_made
     end
 
-    it "should return array of resources" do
-      events = subject.public
-      events.should be_an Array
-      events.should have(1).items
-    end
-
-    it "should be a mash type" do
-      events = subject.public
-      events.first.should be_a Hashie::Mash
+    it_should_behave_like 'an array of resources' do
+      let(:requestable) { subject.public }
     end
 
     it "should get event information" do
@@ -38,18 +31,14 @@ describe Github::Activity::Events, '#public' do
     end
 
     it "should yield to a block" do
-      subject.should_receive(:public).and_yield('web')
-      subject.public { |param| 'web' }
+      yielded = []
+      result = subject.public { |obj| yielded << obj }
+      yielded.should == result
     end
   end
 
-  context "resource not found" do
-    let(:body)   { '' }
-    let(:status) { [404, "Not Found"] }
-
-    it "should return 404 with a message 'Not Found'" do
-      expect { subject.public }.to raise_error(Github::Error::NotFound)
-    end
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.public }
   end
 
 end # public