github_api 0.4.2 → 0.4.3

data/features/error_codes.feature

@@ -0,0 +1,13 @@
+Feature: Handles HTTP error codes
+
+  In order to handle error cases accordingly
+  As a developer
+  I want to be informed of non-successful responses
+
+  Scenario: A response of '401 - Unauthorised access'
+    Given I have "Github::Repos" instance
+    When I am looking for "create_repo"
+      And I pass the following request options:
+        | name       |
+        | basic_auth |
+    Then request should fail with "Github::Unauthorised" within a cassette named "errors/repos/create"

data/features/gists.feature

@@ -0,0 +1,31 @@
+Feature: Accessing Gists Main API
+  In order to interact with github gists
+  GithubAPI gem
+  Should return the expected results depending on passed parameters
+
+  Background:
+    Given I have "Github::Gists" instance
+
+  Scenario: Lists all user's gists
+    When I am looking for "gists" with the following params:
+      | user          |
+      | peter-murach  |
+    And I make request within a cassette named "gists/gists/user_all"
+    Then the response should be "200"
+    And the response type should be "JSON"
+
+  Scenario: Lists all public gists
+    When I am looking for "gists" with the following params:
+      | user |
+      | nil  |
+    And I make request within a cassette named "gists/gists/public_all"
+    Then the response should be "200"
+    And the response type should be "JSON"
+
+  Scenario: Gets a single gist
+    When I am looking for "gist" with the following params:
+      | gist_id |
+      | 1738161 |
+    And I make request within a cassette named "gists/gist"
+    Then the response should be "200"
+    And the response type should be "JSON"

data/features/pagination.feature

@@ -65,3 +65,13 @@ Feature: Githu API pagination
     And the response should have 30 items
     And the response collection of resources is different for "sha" attribute
 
+  Scenario: Requesting resources with per_page helper
+    Given I have "Github::Repos" instance
+    When I am looking for "repos"
+    And I pass the following request options:
+      | user   |
+      | wycats |
+    And I make request within a cassette named "pagination/repos/per_page/first"
+    Then the response should be "200"
+    When I iterate through collection pages within a cassette named "pagination/repos/per_page/each_page"
+    Then this collection should include first page

data/features/repos.feature

@@ -3,28 +3,30 @@ Feature: Accessing Repos Main API
   GithubAPI gem
   Should return the expected results depending on passed parameters
 
-  Scenario: Returning all repository branches
+  Background:
     Given I have "Github::Repos" instance
+
+  Scenario: Returning all repository branches
     When I am looking for "branches" with the following params:
       | user          | repo   |
       | peter-murach  | github |
-    And I make request within a cassette named "repos/branches"
+      And I make request within a cassette named "repos/branches"
     Then the response should be "200"
-    And the response type should be "JSON"
+      And the response type should be "JSON"
 
   Scenario: Returning all repository tags
-    Given I have "Github::Repos" instance
     When I am looking for "tags" with the following params:
       | user          | repo   |
       | peter-murach  | github |
-    And I make request within a cassette named "repos/tags"
+      And I make request within a cassette named "repos/tags"
     Then the response should be "200"
+      And the response type should be "JSON"
 
   Scenario: Returning all repositories for the user
-    Given I have "Github::Repos" instance
     When I am looking for "list_repos"
-    And I pass the following request options:
-      | user          |
-      | peter-murach  |
-    And I make request within a cassette named "repos/tags"
+      And I pass the following request options:
+        | user          |
+        | peter-murach  |
+      And I make request within a cassette named "repos/tags"
     Then the response should be "200"
+      And the response type should be "JSON"

data/features/step_definitions/github_api_steps.rb

@@ -3,11 +3,7 @@ Given /^I have github instance$/ do
 end
 
 Given /^I have "([^"]*)" instance$/ do |api_classes|
-  constant = Object
-  api_classes.split('::').each do |api_class|
-    constant = constant.const_get api_class
-  end
-  @instance = constant.new
+  @instance = convert_to_constant(api_classes).new
 end
 
 When /^I fetch "([^"]*)"$/ do |method|
@@ -45,6 +41,25 @@ When /^I request "([^"]*)" page$/ do |link|
   @next_response = @response.send :"#{link}_page"
 end
 
+When /^I iterate through collection pages$/ do
+  @pages = []
+  @response.each_page do |page|
+    @pages << page.flatten
+  end
+end
+
 Then /^the response collection of resources is different for "([^"]*)" attribute$/ do |attr|
   @next_response.first.send(:"#{attr}").should_not eql @response.first.send(:"#{attr}")
 end
+
+Then /^this collection should include first page$/ do
+  @pages.flatten.map(&:name).should include @response.first.name
+end
+
+Then /^request should fail with "([^"]*)"$/ do |exception|
+  @options ||= {}
+  @attributes ||= {}
+  expect {
+    @response = @instance.send @method, *@attributes.values, @options
+  }.to raise_error(convert_to_constant(exception))
+end

data/features/support/env.rb

@@ -7,6 +7,14 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../spec')
+
+if RUBY_VERSION > '1.9' and ENV['COVERAGE']
+  require 'coverage_adapter'
+  SimpleCov.start 'github_api'
+  SimpleCov.coverage_dir 'coverage/cucumber'
+end
+
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 require 'github_api'
 

data/features/support/helpers.rb

@@ -0,0 +1,7 @@
+def convert_to_constant(classes)
+  constant = Object
+  classes.split('::').each do |klass|
+    constant = constant.const_get klass
+  end
+  return constant
+end

data/lib/github_api.rb

@@ -5,21 +5,21 @@ require 'github_api/configuration'
 require 'github_api/constants'
 require 'github_api/utils/url'
 require 'github_api/connection'
+require 'github_api/deprecation'
 
 module Github
   extend Configuration
 
   class << self
+
+    # Handle for the client instance
+    attr_accessor :api_client
+
     # Alias for Github::Client.new
     #
     # @return [Github::Client]
     def new(options = {}, &block)
-      @@api_client = Github::Client.new(options, &block)
-    end
-
-    # Returns handle for the client instance
-    def api_client
-      @@api_client
+      @api_client = Github::Client.new(options, &block)
     end
 
     # Delegate to Github::Client

data/lib/github_api/api.rb

@@ -44,6 +44,7 @@ module Github
         send("#{key}=", options[key])
       end
       _process_basic_auth(options[:basic_auth])
+      _set_api_client
       client if client_id? && client_secret?
 
       self.instance_eval(&block) if block_given?
@@ -55,14 +56,27 @@ module Github
     def _process_basic_auth(auth)
       case auth
       when String
-        login    = auth.split(':').first
-        password = auth.split(':').last
+        self.login    = auth.split(':').first
+        self.password = auth.split(':').last
       when Hash
-        login    = auth[:login]
-        password = auth[:password]
+        self.login    = auth[:login]
+        self.password = auth[:password]
       end
     end
 
+    # Assigns current api class
+    def _set_api_client
+      Github.api_client = self
+    end
+
+    # Passes configuration options to instantiated class
+    def _create_instance(klass, options)
+      options.symbolize_keys!
+      instance = klass.send :new, options
+      Github.api_client = instance
+      instance
+    end
+
     # Responds to attribute query or attribute clear
     def method_missing(method, *args, &block) # :nodoc:
       case method.to_s
@@ -77,7 +91,7 @@ module Github
 
     def _validate_inputs(required, provided) # :nodoc:
       required.all? do |key|
-        provided.has_key? key
+        provided.has_deep_key? key
       end
     end
 
@@ -187,12 +201,6 @@ module Github
       end
     end
 
-    # Passes configuration options to instantiated class
-    def _create_instance(klass, options)
-      options.symbolize_keys!
-      klass.new(options)
-    end
-
     def _token_required
     end
 

data/lib/github_api/authorization.rb

@@ -54,10 +54,10 @@ module Github
 
     # Select authentication parameters
     def authentication
-      if login? && password?
-        { :login => login, :password => password }
-      elsif basic_auth?
+      if basic_auth?
         { :basic_auth => basic_auth }
+      elsif login? && password?
+        { :login => login, :password => password }
       else
         { }
       end

data/lib/github_api/connection.rb

@@ -54,7 +54,7 @@ module Github
           builder.use Faraday::Request::JSON
           builder.use Faraday::Request::Multipart
           builder.use Faraday::Request::UrlEncoded
-          builder.use Faraday::Response::Logger
+          builder.use Faraday::Response::Logger if ENV['DEBUG']
 
           builder.use Github::Request::OAuth2, oauth_token if oauth_token?
           builder.use Github::Request::BasicAuth, authentication if basic_authed?

data/lib/github_api/core_ext/array.rb

@@ -1,7 +1,6 @@
 class Array # :nodoc:
 
   def except(*keys) # :nodoc:
-    puts "module except works!!!"
     self.dup.except!(*keys)
   end unless method_defined?(:except)
 
@@ -11,4 +10,4 @@ class Array # :nodoc:
     copy
   end unless method_defined?(:except!)
 
-end # Hash
+end # Array

data/lib/github_api/core_ext/hash.rb

@@ -1,7 +1,6 @@
 class Hash # :nodoc:
 
   def except(*items) # :nodoc:
-    puts "array except works!!!"
     self.dup.except!(*items)
   end unless method_defined?(:except)
 
@@ -16,7 +15,7 @@ class Hash # :nodoc:
       hash[(key.to_sym rescue key) || key] = value
       hash
     end
-  end
+  end unless method_defined?(:symbolize_keys)
 
   def symbolize_keys! # :nodoc:
     hash = symbolize_keys
@@ -39,4 +38,19 @@ class Hash # :nodoc:
     self.map { |key, val| [key, val].join("=") }.join("&")
   end unless method_defined?(:serialize)
 
+  def all_keys # :nodoc:
+    keys = self.keys
+    keys.each do |key|
+      if self[key].is_a?(Hash)
+        keys << self[key].all_keys.compact.flatten
+        next
+      end
+    end
+    keys.flatten
+  end unless method_defined?(:all_keys)
+
+  def has_deep_key?(key)
+    self.all_keys.include? key
+  end unless method_defined?(:has_deep_key?)
+
 end # Hash

data/lib/github_api/deprecation.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+module Github
+
+  DEPRECATION_PREFIX = "[GithubAPI] Deprecation warning:"
+
+  class << self
+
+    attr_writer :deprecation_tracker
+
+    def deprecation_tracker
+      @deprecation_tracker ||= []
+    end
+
+    # Displays deprecation message to the user.
+    # Each message is printed once.
+    def deprecate(method, alternate_method=nil)
+      return if deprecation_tracker.include? method
+      deprecation_tracker << method
+
+      message = <<-NOTICE
+#{DEPRECATION_PREFIX}
+
+* #{method} is deprecated.
+NOTICE
+      if alternate_method
+        message << <<-ADDITIONAL
+* please use #{alternate_method} instead.
+ADDITIONAL
+      end
+      warn_deprecation(message)
+    end
+
+    def warn_deprecation(message)
+      send :warn, message
+    end
+  end
+
+end # Github

data/lib/github_api/gists.rb

@@ -9,7 +9,12 @@ module Github
 
     include Github::Gists::Comments
 
-    REQUIRED_GIST_INPUTS = %w[ description public files content ]
+    REQUIRED_GIST_INPUTS = %w[
+      description
+      public
+      files
+      content
+    ].freeze
 
     # Creates new Gists API
     def initialize(options = {})
@@ -53,19 +58,25 @@ module Github
     #
     def starred(params={})
       _normalize_params_keys(params)
-      get("/gists/starred", params)
+
+      response = get("/gists/starred", params)
+      return response unless block_given?
+      response.each { |el| yield el }
     end
 
     # Get a single gist
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '...'
+    #  @github = Github.new
     #  @github.gists.get_gist 'gist-id'
     #
-    def get_gist(gist_id, params={})
+    def gist(gist_id, params={})
       _normalize_params_keys(params)
+      _validate_presence_of(gist_id)
+
       get("/gists/#{gist_id}", params)
     end
+    alias :get_gist :gist
 
     # Create a gist
     #
@@ -78,8 +89,8 @@ module Github
     #        <tt>:content</tt> - Required string - File contents.
     #
     # = Examples
-    #  @github = Github.new :oauth_token => '...'
-    #  @github.gists.create_gist 
+    #  @github = Github.new
+    #  @github.gists.create_gist
     #    'description' => 'the description for this gist',
     #    'public' => true,
     #    'files' => {
@@ -90,7 +101,11 @@ module Github
     #
     def create_gist(params={})
       _normalize_params_keys(params)
-      _filter_params_keys(REQUIRED_GIST_INPUTS, params)
+
+      unless _validate_inputs(REQUIRED_GIST_INPUTS, params)
+        raise ArgumentError,
+          "Required parameters are: #{REQUIRED_GIST_INPUTS.join(', ')}"
+      end
 
       post("/gists", params)
     end
@@ -126,7 +141,6 @@ module Github
     def edit_gist(gist_id, params={})
       _validate_presence_of(gist_id)
       _normalize_params_keys(params)
-      _filter_params_keys(REQUIRED_GIST_INPUTS, params)
 
       patch("/gists/#{gist_id}", params)
     end
@@ -150,14 +164,14 @@ module Github
     #  @github = Github.new
     #  @github.gists.unstar 'gist-id'
     #
-    def unstar_gist(gist_id, params={})
+    def unstar(gist_id, params={})
       _validate_presence_of(gist_id)
       _normalize_params_keys(params)
 
       delete("/gists/#{gist_id}/star", params)
     end
 
-    # Check if a gist is starred 
+    # Check if a gist is starred
     #
     # = Examples
     #  @github = Github.new
@@ -168,6 +182,9 @@ module Github
       _normalize_params_keys(params)
 
       get("/gists/#{gist_id}/star", params)
+      true
+    rescue Github::ResourceNotFound
+      false
     end
 
     # Fork a gist