github_api 0.7.1 → 0.7.2

data/README.md

@@ -11,6 +11,17 @@ A Ruby wrapper for the GitHub REST API v3.
 
 Supports all the API 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.
 
+## Features
+
+* Intuitive GitHub API interface navigation.
+* Modular design allows for working with parts of API.
+* Fully customizable including advanced middleware stack construction.
+* Requests pagination.
+* Easy error handling.
+* Custom Mime Types specification (TODO)
+* Flexible arguments parsing (In progress).
+* Full tested with test coverage above 90%.
+
 ## Installation
 
 Install the gem by issuing

data/lib/github_api/api.rb

@@ -13,6 +13,7 @@ require 'github_api/api/actions'
 require 'github_api/api_factory'
 
 module Github
+  # Core class for api interface operations
   class API
     include Constants
     include Authorization
@@ -86,33 +87,30 @@ module Github
       end
     end
 
-    def update_settings(options={})
-      options.each do |key, val|
-        self.send(:"#{key}", val)
+    # Set an option to a given value
+    def set(option, value=(not_set = true), &block)
+      raise ArgumentError, 'value not set' if block and !not_set
+
+      if not_set
+        set_options option
+        return self
+      end
+
+      if respond_to?("#{option}=")
+        return __send__("#{option}=", value)
       end
-    end
 
-    def _update_user_repo_params(user_name, repo_name=nil) # :nodoc:
-      self.user = user_name || self.user
-      self.repo = repo_name || self.repo
+      self
     end
 
-    # TODO: See whether still needed, consider adding to core_exts
-    def _hash_traverse(hash, &block)
-      hash.each do |key, val|
-        block.call(key)
-        case val
-        when Hash
-          val.keys.each do |k|
-            _hash_traverse(val, &block)
-          end
-        when Array
-          val.each do |item|
-            _hash_traverse(item, &block)
-          end
-        end
+    private
+
+    # Set multiple options
+    def set_options(options)
+      unless options.respond_to?(:each)
+        raise ArgumentError, 'cannot iterate over value'
       end
-      return hash
+      options.each { |key, value| set(key, value) }
     end
 
     def _merge_mime_type(resource, params) # :nodoc:

data/lib/github_api/core_ext/hash.rb

@@ -53,4 +53,21 @@ class Hash # :nodoc:
     self.all_keys.include? key
   end unless method_defined?(:has_deep_key?)
 
+  def self.hash_traverse(hash, &block)
+    hash.each do |key, val|
+      block.call(key)
+      case val
+      when Hash
+        val.keys.each do |k|
+          _hash_traverse(val, &block)
+        end
+      when Array
+        val.each do |item|
+          _hash_traverse(item, &block)
+        end
+      end
+    end
+    return hash
+  end
+
 end # Hash

data/lib/github_api/events.rb

@@ -34,7 +34,7 @@ module Github
     #  github.events.repository 'user-name', 'repo-name' { |event| ... }
     #
     def repository(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -55,7 +55,7 @@ module Github
     #  github.events.issue 'user-name', 'repo-name' { |event| ... }
     #
     def issue(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -75,7 +75,7 @@ module Github
     #  github.events.network 'user-name', 'repo-name' { |event| ... }
     #
     def network(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 

data/lib/github_api/git_data/blobs.rb

@@ -20,7 +20,7 @@ module Github
     #  github.git_data.blobs.get 'user-name', 'repo-name', 'sha'
     #
     def get(user_name, repo_name, sha, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, sha
       normalize! params
 
@@ -40,7 +40,7 @@ module Github
     #    "encoding" => "utf-8"
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params

data/lib/github_api/git_data/commits.rb

@@ -32,7 +32,7 @@ module Github
     #  github.git_data.commits.get 'user-name', 'repo-name', 'sha'
     #
     def get(user_name, repo_name, sha, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, sha
       normalize! params
 
@@ -73,7 +73,7 @@ module Github
     #    "tree": "827efc6d56897b048c772eb4087f854f46256132"]
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
       filter! VALID_COMMIT_PARAM_NAMES, params

data/lib/github_api/git_data/references.rb

@@ -28,7 +28,7 @@ module Github
     #  github.git_data.references.list 'user-name', 'repo-name', ref:'tags'
     #
     def list(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -56,7 +56,7 @@ module Github
     #  github.git_data.references.get 'user-name', 'repo-name', 'heads/branch'
     #
     def get(user_name, repo_name, ref, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, ref
       validate_reference ref
       normalize! params
@@ -79,7 +79,7 @@ module Github
     #    "sha" =>  "827efc6d56897b048c772eb4087f854f46256132"
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       normalize! params
       filter! VALID_REF_PARAM_NAMES, params
       assert_presence_of user, repo, params['ref']
@@ -102,7 +102,7 @@ module Github
     #    "force" => true
     #
     def update(user_name, repo_name, ref, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, ref
       validate_reference ref
       normalize! params
@@ -120,7 +120,7 @@ module Github
     #    "ref" => "refs/heads/master",
     #
     def delete(user_name, repo_name, ref, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, ref
       normalize! params
 

data/lib/github_api/git_data/tags.rb

@@ -34,7 +34,7 @@ module Github
     #  github.git_data.tags.get 'user-name', 'repo-name', 'sha'
     #
     def get(user_name, repo_name, sha, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, sha
       normalize! params
 
@@ -71,7 +71,7 @@ module Github
     #    }
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 

data/lib/github_api/git_data/trees.rb

@@ -40,7 +40,7 @@ module Github
     #  github.git_data.trees.get 'user-name', 'repo-name', 'sha', 'recursive' => true
     #
     def get(user_name, repo_name, sha, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, sha
       normalize! params
 
@@ -85,7 +85,7 @@ module Github
     #    ]
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
       assert_required_keys(%w[ tree ], params)

data/lib/github_api/issues.rb

@@ -132,7 +132,7 @@ module Github
     #    :direction => 'asc'
     #
     def list_repo(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params
@@ -153,7 +153,7 @@ module Github
     #  github.issues.get 'user-name', 'repo-name', 'issue-id'
     #
     def get(user_name, repo_name, issue_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
 
       normalize! params
@@ -184,7 +184,7 @@ module Github
     #    ]
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params
@@ -218,7 +218,7 @@ module Github
     #    ]
     #
     def edit(user_name, repo_name, issue_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
 
       normalize! params

data/lib/github_api/issues/comments.rb

@@ -22,7 +22,7 @@ module Github
     #  github.issues.comments.all 'user-name', 'repo-name', 'issue-id' {|com| .. }
     #
     def list(user_name, repo_name, issue_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
 
       normalize! params
@@ -41,7 +41,7 @@ module Github
     #  github.issues.comments.find 'user-name', 'repo-name', 'comment-id'
     #
     def get(user_name, repo_name, comment_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, comment_id
 
       normalize! params
@@ -62,7 +62,7 @@ module Github
     #     "body" => 'a new comment'
     #
     def create(user_name, repo_name, issue_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
 
       normalize! params
@@ -84,7 +84,7 @@ module Github
     #     "body" => 'a new comment'
     #
     def edit(user_name, repo_name, comment_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, comment_id
 
       normalize! params
@@ -92,7 +92,7 @@ module Github
       filter! VALID_ISSUE_COMMENT_PARAM_NAME, params
       assert_required_keys(%w[ body ], params)
 
-      patch_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}")
+      patch_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
     end
 
     # Delete a comment
@@ -102,7 +102,7 @@ module Github
     #  github.issues.comments.delete 'user-name', 'repo-name', 'comment-id'
     #
     def delete(user_name, repo_name, comment_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, comment_id
 
       normalize! params

data/lib/github_api/issues/events.rb

@@ -21,7 +21,7 @@ module Github
     #  github.issues.events.list 'user-name', 'repo-name'
     #
     def list(user_name, repo_name, issue_id=nil, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -42,7 +42,7 @@ module Github
     #  github.issues.events.get 'user-name', 'repo-name', 'event-id'
     #
     def get(user_name, repo_name, event_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, event_id
       normalize! params
 

data/lib/github_api/issues/labels.rb

@@ -18,7 +18,7 @@ module Github
     #  github.issues.labels.list { |label| ... }
     #
     def list(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
 
@@ -35,7 +35,7 @@ module Github
     #  github.issues.labels.find 'user-name', 'repo-name', 'label-id'
     #
     def get(user_name, repo_name, label_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, label_id
       normalize! params
 
@@ -54,7 +54,7 @@ module Github
     #  github.issues.labels.create :name => 'API', :color => 'FFFFFF'
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params
@@ -76,7 +76,7 @@ module Github
     #    :name => 'API', :color => "FFFFFF"
     #
     def update(user_name, repo_name, label_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, label_id
 
       normalize! params
@@ -94,7 +94,7 @@ module Github
     #  github.issues.labels.delete 'user-name', 'repo-name', 'label-id'
     #
     def delete(user_name, repo_name, label_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       assert_presence_of label_id
@@ -110,7 +110,7 @@ module Github
     #  @github.issues.labels.issue 'user-name', 'repo-name', 'issue-id'
     #
     def issue(user_name, repo_name, issue_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
       normalize! params
 
@@ -127,7 +127,7 @@ module Github
       params = args.extract_options!
       params['data'] = args unless args.empty?
 
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
       normalize! params
 
@@ -147,7 +147,7 @@ module Github
     #  github.issues.labels.remove 'user-name', 'repo-name', 'issue-id'
     #
     def remove(user_name, repo_name, issue_id, label_id=nil, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
       normalize! params
 
@@ -170,7 +170,7 @@ module Github
       params = args.extract_options!
       params['data'] = args unless args.empty?
 
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, issue_id
       normalize! params
 
@@ -184,7 +184,7 @@ module Github
     #  github.issues.labels. 'user-name', 'repo-name', 'milestone-id'
     #
     def milestone(user_name, repo_name, milestone_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, milestone_id
       normalize! params
 

data/lib/github_api/issues/milestones.rb

@@ -39,7 +39,7 @@ module Github
     #     :direction => 'asc'
     #
     def list(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params
@@ -59,7 +59,7 @@ module Github
     #  github.issues.milestones.get 'user-name', 'repo-name', 'milestone-id'
     #
     def get(user_name, repo_name, milestone_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, milestone_id
       normalize! params
 
@@ -83,7 +83,7 @@ module Github
     #    :due_on => "Time"
     #
     def create(user_name, repo_name, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
 
       normalize! params
@@ -110,7 +110,7 @@ module Github
     #    :due_on => "Time"
     #
     def update(user_name, repo_name, milestone_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, milestone_id
 
       normalize! params
@@ -127,7 +127,7 @@ module Github
     #  github.issues.milestones.delete 'user-name', 'repo-name', 'milestone-id'
     #
     def delete(user_name, repo_name, milestone_id, params={})
-      _update_user_repo_params(user_name, repo_name)
+      set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, milestone_id
       normalize! params