github_api 0.6.0 → 0.6.1

data/lib/github_api/repos/hooks.rb

@@ -44,7 +44,7 @@ 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?
-      _normalize_params_keys(params)
+      normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/hooks", params)
       return response unless block_given?
@@ -62,7 +62,7 @@ module Github
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of hook_id
-      _normalize_params_keys(params)
+      normalize! params
 
       get_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
     end
@@ -90,8 +90,8 @@ module Github
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
 
-      _normalize_params_keys(params)
-      _filter_params_keys(VALID_HOOK_PARAM_NAMES, params, :recursive => false)
+      normalize! params
+      filter! VALID_HOOK_PARAM_NAMES, params, :recursive => false
       assert_required_keys(REQUIRED_PARAMS, params)
 
       post_request("/repos/#{user}/#{repo}/hooks", params)
@@ -123,8 +123,8 @@ module Github
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of hook_id
 
-      _normalize_params_keys(params)
-      _filter_params_keys(VALID_HOOK_PARAM_NAMES, params, :recursive => false)
+      normalize! params
+      filter! VALID_HOOK_PARAM_NAMES, params, :recursive => false
       assert_required_keys(REQUIRED_PARAMS, params)
 
       patch_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
@@ -142,7 +142,7 @@ module Github
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of hook_id
-      _normalize_params_keys(params)
+      normalize! params
 
       post_request("/repos/#{user}/#{repo}/hooks/#{hook_id}/test", params)
     end
@@ -157,7 +157,7 @@ module Github
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of hook_id
-      _normalize_params_keys(params)
+      normalize! params
 
       delete_request("/repos/#{user}/#{repo}/hooks/#{hook_id}", params)
     end

data/lib/github_api/repos/keys.rb

@@ -15,7 +15,7 @@ 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?
-      _normalize_params_keys(params)
+      normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/keys", params)
       return response unless block_given?
@@ -33,7 +33,7 @@ module Github
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of key_id
-      _normalize_params_keys(params)
+      normalize! params
 
       get_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
     end
@@ -54,8 +54,8 @@ 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_keys(params)
-      _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+      normalize! params
+      filter! VALID_KEY_PARAM_NAMES, params
       assert_required_keys(VALID_KEY_PARAM_NAMES, params)
 
       post_request("/repos/#{user}/#{repo}/keys", params)
@@ -78,8 +78,8 @@ module Github
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of key_id
 
-      _normalize_params_keys(params)
-      _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+      normalize! params
+      filter! VALID_KEY_PARAM_NAMES, params
 
       patch_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
     end
@@ -94,7 +94,7 @@ module Github
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of key_id
-      _normalize_params_keys(params)
+      normalize! params
 
       delete_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
     end

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -19,7 +19,7 @@ module Github
     #
     def subscribe(topic, callback, params={})
       _validate_presence_of topic, callback
-      _normalize_params_keys(params)
+      normalize! params
       _merge_action!("subscribe", topic, callback, params)
 
       post_request("/hub", params)
@@ -41,7 +41,7 @@ module Github
     #
     def unsubscribe(topic, callback, params={})
       _validate_presence_of topic, callback
-      _normalize_params_keys(params)
+      normalize! params
       _merge_action!("unsubscribe", topic, callback, params)
 
       post_request("/hub", params)
@@ -64,7 +64,7 @@ module Github
     #
     def subscribe_service(user_name, repo_name, service_name, params={})
       _validate_presence_of user_name, repo_name, service_name
-      _normalize_params_keys(params)
+      normalize! params
       event = params.delete('event') || 'push'
       topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
       callback = "github://#{service_name}?#{params.serialize}"
@@ -87,7 +87,7 @@ module Github
     #
     def unsubscribe_service(user_name, repo_name, service_name, params={})
       _validate_presence_of user_name, repo_name, service_name
-      _normalize_params_keys(params)
+      normalize! params
       event = params.delete('event') || 'push'
       topic = "https://github.com/#{user_name}/#{repo_name}/events/#{event}"
       callback = "github://#{service_name}"

data/lib/github_api/repos/watching.rb

@@ -13,7 +13,7 @@ module Github
     def watchers(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
-      _normalize_params_keys(params)
+      normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/watchers", params)
       return response unless block_given?
@@ -34,7 +34,7 @@ module Github
     #
     def watched(*args)
       params = args.extract_options!
-      _normalize_params_keys(params)
+      normalize! params
       _merge_user_into_params!(params) unless params.has_key?('user')
 
       response = if (user_name = params.delete('user'))
@@ -55,7 +55,7 @@ module Github
     #
     def watching?(user_name, repo_name, params={})
       _validate_presence_of user_name, repo_name
-      _normalize_params_keys(params)
+      normalize! params
       get_request("/user/watched/#{user_name}/#{repo_name}", params)
       true
     rescue Github::Error::NotFound
@@ -72,7 +72,7 @@ module Github
     #
     def start_watching(user_name, repo_name, params={})
       _validate_presence_of user_name, repo_name
-      _normalize_params_keys(params)
+      normalize! params
       put_request("/user/watched/#{user_name}/#{repo_name}", params)
     end
 
@@ -85,7 +85,7 @@ module Github
     #
     def stop_watching(user_name, repo_name, params={})
       _validate_presence_of user_name, repo_name
-      _normalize_params_keys(params)
+      normalize! params
       delete_request("/user/watched/#{user_name}/#{repo_name}", params)
     end
 

data/lib/github_api/repos.rb

@@ -100,7 +100,7 @@ module Github
     def branches(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless (user? && repo?)
-      _normalize_params_keys(params)
+      normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/branches", params)
       return response unless block_given?
@@ -140,8 +140,8 @@ module Github
     #
     def create(*args)
       params = args.extract_options!
-      _normalize_params_keys(params)
-      _filter_params_keys(VALID_REPO_OPTIONS + %w[ org ], params)
+      normalize! params
+      filter! VALID_REPO_OPTIONS + %w[ org ], params
       assert_required_keys(%w[ name ], params)
 
       # Requires authenticated user
@@ -166,8 +166,8 @@ module Github
     def contributors(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
-      _normalize_params_keys(params)
-      _filter_params_keys(['anon'], params)
+      normalize! params
+      filter! ['anon'], params
 
       response = get_request("/repos/#{user}/#{repo}/contributors", params)
       return response unless block_given?
@@ -200,8 +200,8 @@ module Github
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
 
-      _normalize_params_keys(params)
-      _filter_params_keys(VALID_REPO_OPTIONS, params)
+      normalize! params
+      filter! VALID_REPO_OPTIONS, params
       assert_required_keys(%w[ name ], params)
 
       patch_request("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
@@ -216,7 +216,7 @@ module Github
     def get(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
-      _normalize_params_keys(params)
+      normalize! params
 
       get_request("/repos/#{user}/#{repo}", params)
     end
@@ -232,7 +232,7 @@ module Github
     def languages(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
-      _normalize_params_keys(params)
+      normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/languages", params)
       return response unless block_given?
@@ -263,9 +263,9 @@ module Github
     #
     def list(*args)
       params = args.extract_options!
-      _normalize_params_keys(params)
+      normalize! params
       _merge_user_into_params!(params) unless params.has_key?('user')
-      _filter_params_keys(%w[ org user type ], params)
+      filter! %w[ org user type ], params
 
       response = if (user_name = params.delete("user"))
         get_request("/users/#{user_name}/repos", params)
@@ -290,7 +290,7 @@ module Github
     def tags(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
-      _normalize_params_keys(params)
+      normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/tags", params)
       return response unless block_given?
@@ -310,7 +310,7 @@ module Github
     def teams(user_name, repo_name, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
-      _normalize_params_keys(params)
+      normalize! params
 
       response = get_request("/repos/#{user}/#{repo}/teams", params)
       return response unless block_given?

data/lib/github_api/search.rb

@@ -22,7 +22,7 @@ module Github
     #
     def issues(*args)
       params = args.extract_options!
-      normalize params
+      normalize! params
 
       required = ['owner', 'repo', 'state', 'keyword']
       assert_required_keys required, params
@@ -48,7 +48,7 @@ module Github
     #
     def repos(*args)
       params = args.extract_options!
-      normalize params
+      normalize! params
       assert_required_keys %w[ keyword ], params
 
       get_request("/legacy/repos/search/#{params.delete('keyword')}", params)
@@ -68,7 +68,7 @@ module Github
     #
     def users(*args)
       params = args.extract_options!
-      normalize params
+      normalize! params
       assert_required_keys %w[ keyword ], params
 
       get_request("/legacy/user/search/#{params.delete('keyword')}", params)
@@ -88,7 +88,7 @@ module Github
     #
     def email(*args)
       params = args.extract_options!
-      normalize params
+      normalize! params
       assert_required_keys %w[ email ], params
 
       get_request("/legacy/user/email/#{params.delete('email')}", params)

data/lib/github_api/users/emails.rb

@@ -12,7 +12,7 @@ module Github
     #  github.users.emails.list { |email| ... }
     #
     def list(params={})
-      _normalize_params_keys(params)
+      normalize! params
       response = get_request("/user/emails", params)
       return response unless block_given?
       response.each { |el| yield el }
@@ -30,7 +30,7 @@ module Github
     #
     def add(*args)
       params = args.extract_options!
-      _normalize_params_keys(params)
+      normalize! params
       params['data'] = args if args
       post_request("/user/emails", params)
     end
@@ -47,7 +47,7 @@ module Github
     #
     def delete(*args)
       params = args.extract_options!
-      _normalize_params_keys(params)
+      normalize! params
       params['data'] = args if args
       delete_request("/user/emails", params)
     end

data/lib/github_api/users/followers.rb

@@ -18,7 +18,7 @@ module Github
     #  github.users.followers { |user| ... }
     #
     def list(user_name=nil, params={})
-      _normalize_params_keys(params)
+      normalize! params
       response = if user_name
         get_request("/users/#{user_name}/followers", params)
       else
@@ -44,7 +44,7 @@ module Github
     #  github.users.followers.following
     #
     def following(user_name=nil, params={})
-      _normalize_params_keys(params)
+      normalize! params
       response = if user_name
         get_request("/users/#{user_name}/following", params)
       else
@@ -62,7 +62,7 @@ module Github
     #
     def following?(user_name, params={})
       _validate_presence_of user_name
-      _normalize_params_keys(params)
+      normalize! params
       get_request("/user/following/#{user_name}", params)
       true
     rescue Github::Error::NotFound
@@ -77,7 +77,7 @@ module Github
     #
     def follow(user_name, params={})
       _validate_presence_of user_name
-      _normalize_params_keys(params)
+      normalize! params
       put_request("/user/following/#{user_name}", params)
     end
 
@@ -89,7 +89,7 @@ module Github
     #
     def unfollow(user_name, params={})
       _validate_presence_of user_name
-      _normalize_params_keys(params)
+      normalize! params
       delete_request("/user/following/#{user_name}", params)
     end
 

data/lib/github_api/users/keys.rb

@@ -13,7 +13,7 @@ module Github
     #  github.users.followers.list { |key| ... }
     #
     def list(params={})
-      _normalize_params_keys(params)
+      normalize! params
       response = get_request("/user/keys", params)
       return response unless block_given?
       response.each { |el| yield el }
@@ -28,7 +28,7 @@ module Github
     #
     def get(key_id, params={})
       _validate_presence_of key_id
-      _normalize_params_keys(params)
+      normalize! params
       get_request("/user/keys/#{key_id}", params)
     end
     alias :find :get
@@ -45,8 +45,8 @@ module Github
     #    "key" => "ssh-rsa AAA..."
     #
     def create(params={})
-      _normalize_params_keys(params)
-      _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+      normalize! params
+      filter! VALID_KEY_PARAM_NAMES, params
       post_request("/user/keys", params)
     end
 
@@ -63,8 +63,8 @@ module Github
     #
     def update(key_id, params={})
       _validate_presence_of key_id
-      _normalize_params_keys(params)
-      _filter_params_keys(VALID_KEY_PARAM_NAMES, params)
+      normalize! params
+      filter! VALID_KEY_PARAM_NAMES, params
       patch_request("/user/keys/#{key_id}", params)
     end
 
@@ -76,7 +76,7 @@ module Github
     #
     def delete(key_id, params={})
       _validate_presence_of key_id
-      _normalize_params_keys(params)
+      normalize! params
       delete_request("/user/keys/#{key_id}", params)
     end
 

data/lib/github_api/users.rb

@@ -54,7 +54,7 @@ module Github
     #
     def get(*args)
       params = args.extract_options!
-      _normalize_params_keys(params)
+      normalize! params
       if user_name = params.delete('user')
         get_request("/users/#{user_name}", params)
       else
@@ -87,8 +87,8 @@ module Github
     #
     def update(*args)
       params = args.extract_options!
-      _normalize_params_keys(params)
-      _filter_params_keys(VALID_USER_PARAMS_NAMES, params)
+      normalize! params
+      filter! VALID_USER_PARAMS_NAMES, params
       patch_request("/user", params)
     end
 

data/lib/github_api/validations/presence.rb

@@ -4,6 +4,7 @@ module Github
   module Validations
     module Presence
 
+      # TODO: Rename this
       # Ensures that esential arguments are present before request is made
       #
       def _validate_presence_of(*params)

data/lib/github_api/version.rb

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

data/lib/github_api.rb

@@ -59,30 +59,31 @@ module Github
   extend AutoloadHelper
 
   autoload_all 'github_api',
-    :API          => 'api',
-    :ApiFactory   => 'api_factory',
-    :Client       => 'client',
-    :Repos        => 'repos',
-    :Request      => 'request',
-    :Response     => 'response',
-    :Result       => 'result',
-    :Error        => 'error',
-    :Issues       => 'issues',
-    :Gists        => 'gists',
-    :GitData      => 'git_data',
-    :Orgs         => 'orgs',
-    :PullRequests => 'pull_requests',
-    :Users        => 'users',
-    :Events       => 'events',
-    :Search       => 'search',
-    :CoreExt      => 'core_ext',
-    :MimeType     => 'mime_type',
-    :Authorization => 'authorization',
-    :Authorizations => 'authorizations',
-    :PageLinks    => 'page_links',
-    :PageIterator => 'page_iterator',
-    :PagedRequest => 'paged_request',
-    :Validations  => 'validations',
-    :Filter       => 'filter'
+    :API             => 'api',
+    :ApiFactory      => 'api_factory',
+    :Client          => 'client',
+    :Repos           => 'repos',
+    :Request         => 'request',
+    :Response        => 'response',
+    :Result          => 'result',
+    :Error           => 'error',
+    :Issues          => 'issues',
+    :Gists           => 'gists',
+    :GitData         => 'git_data',
+    :Orgs            => 'orgs',
+    :PullRequests    => 'pull_requests',
+    :Users           => 'users',
+    :Events          => 'events',
+    :Search          => 'search',
+    :CoreExt         => 'core_ext',
+    :MimeType        => 'mime_type',
+    :Authorization   => 'authorization',
+    :Authorizations  => 'authorizations',
+    :PageLinks       => 'page_links',
+    :PageIterator    => 'page_iterator',
+    :PagedRequest    => 'paged_request',
+    :Validations     => 'validations',
+    :ParameterFilter => 'parameter_filter',
+    :Normalizer      => 'normalizer'
 
 end # Github

data/spec/github/api_spec.rb

@@ -46,23 +46,23 @@ describe Github::API do
     end
   end
 
-  context '_normalize_params_keys' do
+  context 'normalize!' do
     before do
       @params = { 'a' => { :b => { 'c' => 1 }, 'd' => [ 'a', { :e => 2 }] } }
     end
 
     it "should stringify all the keys inside nested hash" do
-      actual = api.send(:_normalize_params_keys, @params)
+      actual = api.normalize! @params
       expected = { 'a' => { 'b'=> { 'c' => 1 }, 'd' => [ 'a', { 'e'=> 2 }] } }
       actual.should be_eql expected
     end
   end
 
-  context '_filter_params_key' do
+  context 'filter!' do
     it "should remove non valid param keys" do
       valid = ['a', 'b', 'e']
       hash = {'a' => 1, 'b' => 3, 'c' => 2, 'd'=> 4, 'e' => 5 }
-      actual = api.send(:_filter_params_keys, valid, hash)
+      actual = api.filter! valid, hash
       expected = {'a' => 1, 'b' => 3, 'e' => 5 }
       actual.should be_eql expected
     end

data/spec/github/normalizer_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'github_api/core_ext/hash'
+
+describe Github::Normalizer do
+  let(:github) { Github.new }
+  let(:repos_instance) { Github::Repos.new }
+  let(:hash) {  { :a => { :b => { :c => 1 } } }  }
+
+  context '#normalize!' do
+    it 'converts hash keys to string' do
+      ['a', 'b', 'c'].each do |key|
+        github.repos.normalize!(hash).all_keys.should include key
+      end
+      [:a, :b, :c].each do |key|
+        github.repos.normalize!(hash).all_keys.should_not include key
+      end
+    end
+  end
+
+end # Github::Normalizer

data/spec/github/parameter_filter_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'github_api/core_ext/hash'
+
+describe Github::ParameterFilter do
+  let(:github) { Github.new }
+  let(:repos_instance) { Github::Repos.new }
+  let(:block) {
+    Proc.new do |repo|
+      repo = repos_instance
+    end
+  }
+  let(:hash) {  { :a => { :b => { :c => 1 } } }  }
+
+  context '#filter!' do
+    it 'removes unwanted keys from hash' do
+      github.repos.filter!([:a], hash)
+      hash.all_keys.should     include :a
+      hash.all_keys.should_not include :b
+      hash.all_keys.should_not include :c
+    end
+
+    it 'recursively filters inputs tree' do
+      github.repos.filter!([:a, :b], hash)
+      hash.all_keys.should_not include :c
+    end
+
+    it 'filters inputs tree only on top level' do
+      github.repos.filter!([:a, :b], hash, :recursive => false)
+      hash.all_keys.should include :c
+    end
+  end
+
+#   context '#process_params' do
+# 
+#     it 'correctly yields current api instance' do
+#       github.repos.should_receive(:process_params).and_yield repos_instance
+#       github.repos.process_params(&block).should eq repos_instance
+#     end
+#   end
+
+#   context '#normalize' do
+#     it 'should call normalize on passed block' do
+#       github.repos.process_params(&block).should respond_to :normalize
+#     end
+# 
+#     it 'should normalize params inside block' do
+#       github.repos.stub(:process_params).and_yield repos_instance
+#       github.repos.process_params do |repo|
+#         repo.normalize hash
+#       end
+#       hash.all_keys.should include 'a'
+#       hash.all_keys.should_not include :a
+#     end
+#   end
+
+#   context '#filter' do
+#     it 'should call filter on passed block' do
+#       github.repos.process_params(&block).should respond_to :filter
+#     end
+# 
+#     it 'should filter params inside block' do
+#       github.repos.stub(:process_params).and_yield repos_instance
+#       github.repos.process_params do |repo|
+#         repo.filter [:a], hash
+#       end
+#       hash.all_keys.should     include :a
+#       hash.all_keys.should_not include :b
+#     end
+#   end
+
+end # Github::ParameterFilter