github_api 0.7.0 → 0.7.1

data/README.md

@@ -11,9 +11,6 @@ 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.
 
-## Important!!
-Since version 0.5 the way the gem queries the GitHub api underwent important changes. It closely mirros the Github api hierarchy e.i. if you want to create a download resource, lookup the github api spec and issue the request as in `github.repos.downloads.create`
-
 ## Installation
 
 Install the gem by issuing
@@ -30,7 +27,13 @@ gem "github_api"
 
 ## Usage
 
-Create a new client instance
+To start using the gem you can either perform direct call on the `Github`
+
+```ruby
+Github.repos.list user: 'wycats'
+```
+
+or create a new client instance
 
 ```ruby
 github = Github.new
@@ -64,7 +67,10 @@ or use convenience method:
 github = Github.new basic_auth: 'login:password'
 ```
 
-You can interact with GitHub interface, for example repositories, by issuing following calls that correspond directly to the GitHub API hierarchy
+This gem closely mirros the GitHub Api hierarchy e.i. if you want to create a download resource,
+lookup the github api spec and issue the request as in `github.repos.downloads.create`
+
+For example to interact with GitHub Repositories API, issue the following calls that correspond directly to the GitHub API hierarchy
 
 ```ruby
 github.repos.commits.all  'user-name', 'repo-name'

data/Rakefile

@@ -10,4 +10,6 @@ end
 
 Cucumber::Rake::Task.new(:features)
 
+FileList['tasks/**/*.rake'].each { |task| import task }
+
 task :default => [:spec, :features]

data/features/repos/statuses.feature

@@ -13,15 +13,15 @@ Feature: Statuses API
       And the response type should be JSON
       And the response should not be empty
 
-  Scenario: Create
-
-    Given I want to create resource with the following params:
-      | user  | repo            | sha                                      |
-      | murek | github_api_test | 0106b45311ab15bf837c2830391b01cd17b33b61 |
-      And I pass the following request options:
-      | state   | target_url                         | description        |
-      | success | http://ci.example.com/peter-murach | Test by github_api |
-    When I make request within a cassette named "repos/statuses/create"
-    Then the response status should be 201
-      And the response type should be JSON
-      And the response should not be empty
+#   Scenario: Create
+# 
+#     Given I want to create resource with the following params:
+#       | user  | repo            | sha                                      |
+#       | murek | github_api_test | 0106b45311ab15bf837c2830391b01cd17b33b61 |
+#       And I pass the following request options:
+#       | state   | target_url                         | description        |
+#       | success | http://ci.example.com/peter-murach | Test by github_api |
+#     When I make request within a cassette named "repos/statuses/create"
+#     Then the response status should be 201
+#       And the response type should be JSON
+#       And the response should not be empty

data/lib/github_api/api.rb

@@ -88,7 +88,7 @@ module Github
 
     def update_settings(options={})
       options.each do |key, val|
-        self.instance_variable_set(:"@#{key}", val)
+        self.send(:"#{key}", val)
       end
     end
 

data/lib/github_api/authorizations.rb

@@ -38,7 +38,7 @@ module Github
     #  github.oauth.get 'authorization-id'
     #
     def get(authorization_id, params={})
-      _validate_presence_of(authorization_id)
+      assert_presence_of(authorization_id)
       _check_if_authenticated
       normalize! params
 
@@ -81,7 +81,7 @@ module Github
     #
     def update(authorization_id, params={})
       _check_if_authenticated
-      _validate_presence_of(authorization_id)
+      assert_presence_of authorization_id
 
       normalize! params
       filter! VALID_AUTH_PARAM_NAMES, params
@@ -96,7 +96,7 @@ module Github
     #
     def delete(authorization_id, params={})
       _check_if_authenticated
-      _validate_presence_of(authorization_id)
+      assert_presence_of authorization_id
 
       normalize! params
       filter! VALID_AUTH_PARAM_NAMES, params

data/lib/github_api/events.rb

@@ -35,7 +35,7 @@ module Github
     #
     def repository(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/events", params)
@@ -56,7 +56,7 @@ module Github
     #
     def issue(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/issues/events", params)
@@ -76,7 +76,7 @@ module Github
     #
     def network(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = get_request("/networks/#{user}/#{repo}/events", params)
@@ -96,7 +96,7 @@ module Github
     #  github.events.org 'org-name' { |event| ... }
     #
     def org(org_name, params={})
-      _validate_presence_of org_name
+      assert_presence_of org_name
       normalize! params
 
       response = get_request("/orgs/#{org_name}/events", params)
@@ -127,7 +127,7 @@ module Github
     #  github.events.received 'user-name', :public => true { |event| ... }
     #
     def received(user_name, params={})
-      _validate_presence_of user_name
+      assert_presence_of user_name
       normalize! params
 
       public_events = if params['public']
@@ -160,7 +160,7 @@ module Github
     #  github.events.performed 'user-name', :public => true { |event| ... }
     #
     def performed(user_name, params={})
-      _validate_presence_of user_name
+      assert_presence_of user_name
       normalize! params
 
       public_events = if params['public']
@@ -186,7 +186,7 @@ module Github
     #  github.events.user_org 'user-name', 'org-name' { |event| ... }
     #
     def user_org(user_name, org_name, params={})
-      _validate_presence_of user_name, org_name
+      assert_presence_of user_name, org_name
       normalize! params
 
       response = get_request("/users/#{user_name}/events/orgs/#{org_name}", params)

data/lib/github_api/gists.rb

@@ -76,7 +76,7 @@ module Github
     #
     def get(gist_id, params={})
       normalize! params
-      _validate_presence_of(gist_id)
+      assert_presence_of gist_id
 
       get_request("/gists/#{gist_id}", params)
     end
@@ -139,7 +139,7 @@ module Github
     #    }
     #
     def edit(gist_id, params={})
-      _validate_presence_of(gist_id)
+      assert_presence_of gist_id
       normalize! params
 
       patch_request("/gists/#{gist_id}", params)
@@ -152,7 +152,7 @@ module Github
     #  github.gists.star 'gist-id'
     #
     def star(gist_id, params={})
-      _validate_presence_of(gist_id)
+      assert_presence_of gist_id
       normalize! params
 
       put_request("/gists/#{gist_id}/star", params)
@@ -165,7 +165,7 @@ module Github
     #  github.gists.unstar 'gist-id'
     #
     def unstar(gist_id, params={})
-      _validate_presence_of(gist_id)
+      assert_presence_of gist_id
       normalize! params
 
       delete_request("/gists/#{gist_id}/star", params)
@@ -178,7 +178,7 @@ module Github
     #  github.gists.starred? 'gist-id'
     #
     def starred?(gist_id, params={})
-      _validate_presence_of(gist_id)
+      assert_presence_of gist_id
       normalize! params
 
       get_request("/gists/#{gist_id}/star", params)
@@ -194,7 +194,7 @@ module Github
     #  github.gists.fork 'gist-id'
     #
     def fork(gist_id, params={})
-      _validate_presence_of(gist_id)
+      assert_presence_of gist_id
       normalize! params
 
       post_request("/gists/#{gist_id}/fork", params)
@@ -207,7 +207,7 @@ module Github
     #  github.gists.delete 'gist-id'
     #
     def delete(gist_id, params={})
-      _validate_presence_of(gist_id)
+      assert_presence_of gist_id
       normalize! params
 
       delete_request("/gists/#{gist_id}", params)

data/lib/github_api/gists/comments.rb

@@ -21,7 +21,7 @@ module Github
     #
     def list(gist_id, params={})
       normalize! params
-      _validate_presence_of(gist_id)
+      assert_presence_of gist_id
       # _merge_mime_type(:gist_comment, params)
 
       response = get_request("/gists/#{gist_id}/comments", params)
@@ -38,7 +38,7 @@ module Github
     #
     def get(comment_id, params={})
       normalize! params
-      _validate_presence_of(comment_id)
+      assert_presence_of comment_id
       # _merge_mime_type(:gist_comment, params)
 
       get_request("/gists/comments/#{comment_id}", params)
@@ -68,7 +68,7 @@ module Github
     #
     def edit(comment_id, params={})
       normalize! params
-      _validate_presence_of(comment_id)
+      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)
@@ -84,7 +84,7 @@ module Github
     #
     def delete(comment_id, params={})
       normalize! params
-      _validate_presence_of(comment_id)
+      assert_presence_of comment_id
       # _merge_mime_type(:gist_comment, params)
 
       delete_request("/gists/comments/#{comment_id}", params)

data/lib/github_api/git_data/blobs.rb

@@ -21,8 +21,7 @@ module Github
     #
     def get(user_name, repo_name, sha, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of sha
+      assert_presence_of user, repo, sha
       normalize! params
 
       get_request("/repos/#{user}/#{repo}/git/blobs/#{sha}", params)
@@ -42,7 +41,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
 
       normalize! params
       filter! VALID_BLOB_PARAM_NAMES, params

data/lib/github_api/git_data/commits.rb

@@ -33,8 +33,7 @@ module Github
     #
     def get(user_name, repo_name, sha, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of sha
+      assert_presence_of user, repo, sha
       normalize! params
 
       get_request("/repos/#{user}/#{repo}/git/commits/#{sha}", params)
@@ -75,7 +74,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
       filter! VALID_COMMIT_PARAM_NAMES, params
       assert_required_keys(REQUIRED_COMMIT_PARAMS, params)

data/lib/github_api/git_data/references.rb

@@ -29,12 +29,12 @@ module Github
     #
     def list(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       response = if params['ref']
         ref = params.delete('ref')
-        _validate_reference ref
+        validate_reference ref
         get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
       else
         get_request("/repos/#{user}/#{repo}/git/refs", params)
@@ -57,10 +57,8 @@ module Github
     #
     def get(user_name, repo_name, ref, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-
-      _validate_presence_of ref
-      _validate_reference ref
+      assert_presence_of user, repo, ref
+      validate_reference ref
       normalize! params
 
       get_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
@@ -82,12 +80,10 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-
       normalize! params
       filter! VALID_REF_PARAM_NAMES, params
-      _validate_presence_of params['ref']
-      _validate_reference params['ref']
+      assert_presence_of user, repo, params['ref']
+      validate_reference params['ref']
       assert_required_keys(%w[ ref sha ], params)
 
       post_request("/repos/#{user}/#{repo}/git/refs", params)
@@ -107,10 +103,8 @@ module Github
     #
     def update(user_name, repo_name, ref, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-
-      _validate_presence_of ref
-      _validate_reference ref
+      assert_presence_of user, repo, ref
+      validate_reference ref
       normalize! params
       filter! VALID_REF_PARAM_NAMES, params
       assert_required_keys(%w[ sha ], params)
@@ -127,9 +121,8 @@ module Github
     #
     def delete(user_name, repo_name, ref, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo, ref
       normalize! params
-      _validate_presence_of ref
 
       delete_request("/repos/#{user}/#{repo}/git/refs/#{ref}", params)
     end
@@ -137,7 +130,7 @@ module Github
 
   private
 
-    def _validate_reference ref
+    def validate_reference ref
       refs = ref.index('ref') ? ref : "refs/#{ref}"
       unless VALID_REF_PARAM_VALUES['ref'] =~ refs
         raise ArgumentError, "Provided 'reference' is invalid"

data/lib/github_api/git_data/tags.rb

@@ -35,8 +35,7 @@ module Github
     #
     def get(user_name, repo_name, sha, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of sha
+      assert_presence_of user, repo, sha
       normalize! params
 
       get_request("/repos/#{user}/#{repo}/git/tags/#{sha}", params)
@@ -73,7 +72,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
 
       filter! VALID_TAG_PARAM_NAMES, params

data/lib/github_api/git_data/trees.rb

@@ -41,8 +41,7 @@ module Github
     #
     def get(user_name, repo_name, sha, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of sha
+      assert_presence_of user, repo, sha
       normalize! params
 
       response = if params['recursive']
@@ -87,7 +86,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
       normalize! params
       assert_required_keys(%w[ tree ], params)
 

data/lib/github_api/issues.rb

@@ -133,7 +133,7 @@ module Github
     #
     def list_repo(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
 
       normalize! params
       filter! VALID_ISSUE_PARAM_NAMES, params
@@ -154,8 +154,7 @@ module Github
     #
     def get(user_name, repo_name, issue_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of issue_id
+      assert_presence_of user, repo, issue_id
 
       normalize! params
       # _merge_mime_type(:issue, params)
@@ -186,7 +185,7 @@ module Github
     #
     def create(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
+      assert_presence_of user, repo
 
       normalize! params
       # _merge_mime_type(:issue, params)
@@ -220,8 +219,7 @@ module Github
     #
     def edit(user_name, repo_name, issue_id, params={})
       _update_user_repo_params(user_name, repo_name)
-      _validate_user_repo_params(user, repo) unless user? && repo?
-      _validate_presence_of issue_id
+      assert_presence_of user, repo, issue_id
 
       normalize! params
       # _merge_mime_type(:issue, params)