github_api 0.9.7 → 0.10.0

data/features/cassettes/search/users_keyword.yml

@@ -0,0 +1,70 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/legacy/user/search/location:Sheffield%20repos:20?access_token=<TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3.full+json,application/vnd.github.beta.full+json;q=0.7,application/vnd.github+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.9.7
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 18 May 2013 13:33:41 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4999'
+      X-Github-Media-Type:
+      - github.v3; param=full; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Etag:
+      - ! '"719c73d7273332047f0d1eacf695cedd"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Vary:
+      - Accept-Encoding
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA3WQ3WrDMAyFXyX4uh124qRJXmEMxn5uNkZQ/JMaHDs49kYp
+        fffJoYXBNvCFj/Tp6KAzSasKK+nfz8RI0m9yzzmvWEl2ZArwCRHCsPX0WPJO
+        1nXDgepW1EDHplNUHpis2453OJDHHcwK6UVFtJpTAHHEjvWTcb/LV/jR+BiK
+        hxusk7V/d6wXEI3PTs9HpbVRVu6KV2eiksW9cZP0c94Gbkow5RxPaTxhJZ6W
+        rHJAVEsarRFDUIsfhE8ukr6kO5I1HiN/tbfWf223qZof8obn4ip8QFN2h7wI
+        CjDDAGhFSsroPr/2hR36ivWUvuHWK/MfcPm4fAP71GbikAEAAA==
+    http_version: !!null 
+  recorded_at: Sat, 18 May 2013 13:33:41 GMT
+recorded_with: VCR 2.4.0

data/features/gitignore.feature

@@ -29,7 +29,7 @@ Feature: Markdown API
       | template_name |
       | Ruby          |
     And I pass the following request options:
-      | mime                       |
+      | accept                     |
       | application/vnd.github.raw |
     When I make request within a cassette named "gitignore/get_raw"
     Then the response status should be 200

data/features/media_type.feature

@@ -0,0 +1,76 @@
+Feature: Media Type
+
+  Background:
+    Given I have "Github::Issues" instance
+
+  Scenario: Default media
+
+    Given I want to get resource with the following params:
+      | user          | repo   | issue_id |
+      | peter-murach  | github | 108      |
+    When I make request within a cassette named "media/get_default"
+    Then the response status should be 200
+      And the request header Accept should be
+      """
+      application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      """
+
+  Scenario: Raw media
+
+    Given I want to get resource with the following params:
+      | user          | repo   | issue_id |
+      | peter-murach  | github | 108      |
+    And I pass the following request options:
+      | media |
+      | raw   |
+    When I make request within a cassette named "media/get_raw_json"
+    Then the response status should be 200
+      And the request header Accept should be
+      """
+      application/vnd.github.v3.raw+json
+      """
+
+  Scenario: Text media
+
+    Given I want to get resource with the following params:
+      | user          | repo   | issue_id |
+      | peter-murach  | github | 108      |
+    And I pass the following request options:
+      | media |
+      | text   |
+    When I make request within a cassette named "media/get_text_json"
+    Then the response status should be 200
+      And the request header Accept should be
+      """
+      application/vnd.github.v3.text+json
+      """
+
+  Scenario: Html media
+
+    Given I want to get resource with the following params:
+      | user          | repo   | issue_id |
+      | peter-murach  | github | 108      |
+    And I pass the following request options:
+      | media |
+      | html   |
+    When I make request within a cassette named "media/get_html_json"
+    Then the response status should be 200
+      And the request header Accept should be
+      """
+      application/vnd.github.v3.html+json
+      """
+
+  Scenario: Full media
+
+    Given I want to get resource with the following params:
+      | user          | repo   | issue_id |
+      | peter-murach  | github | 108      |
+    And I pass the following request options:
+      | media     |
+      | beta.full |
+    When I make request within a cassette named "media/get_full_json"
+    Then the response status should be 200
+      And the request header Accept should be
+      """
+      application/vnd.github.beta.full+json
+      """

data/features/repos/statistics.feature

@@ -0,0 +1,60 @@
+Feature: Statistics API
+
+  Background:
+    Given I have "Github::Repos::Statistics" instance
+
+  Scenario: Contributors
+
+    Given I want contributors resources
+      And I pass the following request options:
+        | user         | repo   |
+        | peter-murach | github |
+    When I make request within a cassette named "repos/stats/contribs"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Commit Activity
+
+    Given I want commit_activity resources
+      And I pass the following request options:
+        | user         | repo   |
+        | peter-murach | github |
+    When I make request within a cassette named "repos/stats/commits"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+#   Scenario: Code Frequency
+# 
+#     Given I want code_frequency resources
+#       And I pass the following request options:
+#         | user         | repo   |
+#         | peter-murach | github |
+#     When I make request within a cassette named "repos/stats/frequency"
+#     Then the response status should be 200
+#       And the response type should be JSON
+#       And the response should not be empty
+
+  Scenario: Participation
+
+    Given I want participation resources
+      And I pass the following request options:
+        | user         | repo   |
+        | peter-murach | github |
+    When I make request within a cassette named "repos/stats/participation"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Punch Card
+
+    Given I want punch_card resources
+      And I pass the following request options:
+        | user         | repo   |
+        | peter-murach | github |
+    When I make request within a cassette named "repos/stats/punch"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+

data/features/search.feature

@@ -36,6 +36,17 @@ Feature: Search API
       And the response type should be JSON
       And the response should not be empty
 
+  Scenario: Users with complex keyword
+
+    Given I want users resource
+      And I pass the following request options:
+        | keyword                     |
+        | location:Sheffield repos:20 |
+    When I make request within a cassette named "search/users_keyword"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
   Scenario: Email
 
     Given I want email resource

data/features/step_definitions/github_api_steps.rb

@@ -71,6 +71,10 @@ When /^I iterate through collection pages$/ do
   end
 end
 
+Then /^the request header (.*) should be$/ do |header, value|
+  expect(@response.headers.env[:request_headers][header]).to eql(value)
+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

data/lib/github_api.rb

@@ -7,6 +7,7 @@ require 'github_api/utils/url'
 require 'github_api/connection'
 require 'github_api/deprecation'
 require 'github_api/core_ext/ordered_hash'
+require 'github_api/core_ext/deep_merge'
 
 module Github
   extend Configuration
@@ -90,6 +91,7 @@ module Github
     :PagedRequest    => 'paged_request',
     :Validations     => 'validations',
     :ParameterFilter => 'parameter_filter',
+    :ParamsHash      => 'params_hash',
     :Normalizer      => 'normalizer'
 
 end # Github

data/lib/github_api/arguments.rb

@@ -45,7 +45,7 @@ module Github
     # Arguments can be part of parameters hash or be simple string arguments.
     #
     def parse(*args, &block)
-      options = args.extract_options!
+      options = ParamsHash.new(args.extract_options!)
       normalize! options
 
       if !args.size.zero?

data/lib/github_api/authorization.rb

@@ -25,7 +25,7 @@ module Github
 
     # Sends authorization request to GitHub.
     # = Parameters
-    # * <tt>:redirect_uri</tt> - Required string.
+    # * <tt>:redirect_uri</tt> - Optional string.
     # * <tt>:scope</tt> - Optional string. Comma separated list of scopes.
     #   Available scopes:
     #   * (no scope) - public read-only access (includes public user profile info, public repo info, and gists).

data/lib/github_api/connection.rb

@@ -26,17 +26,15 @@ module Github
     def default_options(options={})
       {
         :headers => {
-          ACCEPT           => "application/vnd.github.v3.full+json," \
-                              "application/vnd.github.beta.full+json;q=0.7," \
-                              "application/vnd.github+json;q=0.5," \
+          ACCEPT           => "application/vnd.github.v3+json," \
+                              "application/vnd.github.beta+json;q=0.5," \
                               "application/json;q=0.1",
           ACCEPT_CHARSET   => "utf-8",
-          USER_AGENT       => user_agent,
-          CONTENT_TYPE     => 'application/json'
+          USER_AGENT       => user_agent
         },
-        :ssl => options.fetch(:ssl) { ssl },
+        :ssl => ssl,
         :url => options.fetch(:endpoint) { Github.endpoint }
-      }.merge(options)
+      }.deep_merge(options)
     end
 
     # Default middleware stack that uses default adapter as specified at

data/lib/github_api/core_ext/deep_merge.rb

@@ -0,0 +1,13 @@
+class Hash
+  def deep_merge(other)
+    dup.deep_merge!(other)
+  end
+
+  def deep_merge!(other)
+    other.each_pair do |key, val|
+      tval = self[key]
+      self[key] = tval.is_a?(Hash) && val.is_a?(Hash) ? tval.deep_merge(val) : val
+    end
+    self
+  end
+end

data/lib/github_api/git_data/trees.rb

@@ -81,7 +81,7 @@ module Github
     def create(*args)
       arguments(args, :required => [:user, :repo]) do
         assert_required %w[ tree ]
-        sift VALID_TREE_PARAM_NAMES, 'tree'
+        sift VALID_TREE_PARAM_NAMES, 'tree', { recursive: true }
         assert_values VALID_TREE_PARAM_VALUES, 'tree'
       end
 

data/lib/github_api/gitignore.rb

@@ -32,16 +32,17 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.gitignore.get "template-name", mime: 'applicatin/vnd.github.raw'
+    #  github.gitignore.get "template-name", accept: 'applicatin/vnd.github.raw'
     #
     def get(*args)
       params = arguments(args, :required => [:name]).params
 
-      if (mime_type = params.delete('mime'))
-        options = { :raw => true, :headers => {'Accept' => mime_type} }
+      if (media = params.delete('accept'))
+        params['accept'] = media
+        params['raw'] = true
       end
 
-      get_request("/gitignore/templates/#{name}", params, options || {})
+      get_request("/gitignore/templates/#{name}", params)
     end
     alias :find :get
 

data/lib/github_api/markdown.rb

@@ -28,11 +28,12 @@ module Github
       arguments(args) do
         assert_required ['text']
       end
+      params = arguments.params
+      params['raw'] = true
 
-      post_request("markdown", arguments.params, :raw => true)
+      post_request("markdown", arguments.params)
     end
 
-
     # Render a Markdown document in raw mode
     #
     # = Input
@@ -44,14 +45,15 @@ module Github
     # = Examples
     #  github = Github.new
     #  github.markdown.render_raw "Hello github/linguist#1 **cool**, and #1!",
-    #    "mime": "text/plain",
+    #    "accept": "text/plain",
     #
     def render_raw(*args)
       params = arguments(args).params
       mime_type, params['data'] = params['mime'], args.shift
+      params['raw'] = true
+      params['accept'] = params.fetch('accept') { 'text/plain' }
 
-      post_request("markdown/raw", params, :raw => true,
-                      :headers => {'Content-Type' => mime_type || 'text/plain'})
+      post_request("markdown/raw", params)
     end
 
   end # Markdown

data/lib/github_api/mime_type.rb

@@ -3,51 +3,29 @@
 module Github
   module MimeType
 
-    attr_accessor :accepts
-
-    RESOURCE_LOOKUP = {
-      :json           => 'json',
-      :issue          => 'vnd.github-issue.',
-      :issue_comment  => 'vnd.github-issuecomment.',
-      :commit_comment => 'vnd.github-commitcomment.',
-      :pull_request   => 'vnd.github-pull.',
-      :pull_comment   => 'vnd.github-pullcomment.',
-      :gist_comment   => 'vnd.github-gistcomment.',
-      :blob           => 'vnd.github-blob.'
-    }
-
-    MIME_LOOKUP = {
-      :json => 'json',
-      :blob => 'raw',
-      :raw  => 'raw+json',
-      :text => 'text+json',
-      :html => 'html+json',
-      :full => 'full+json'
+    MEDIA_LOOKUP = {
+      'json' => 'json',
+      'blob' => 'raw',
+      'raw'  => 'raw+json',
+      'text' => 'text+json',
+      'html' => 'html+json',
+      'full' => 'full+json'
     }
 
-    def parse(resource = nil, mime_type = :json)
-      resource  = lookup_resource(resource) if resource
-      mime_type = lookup_mime(mime_type)
-      self.accepts = "application/#{resource || ''}#{mime_type}"
-    end
-
-    def lookup_resource(name)
-      RESOURCE_LOOKUP.fetch(name)
-    end
-
-    def lookup_mime(name)
-      MIME_LOOKUP.fetch(name)
+    # Parse media type param
+    #
+    def parse(media)
+      version = 'v3'
+      media.sub!(/^[.]*|[.]*$/,"")
+      media = media.include?('+') ? media.split('+')[0] : media
+      version, media = media.split('.') if media.include?('.')
+      media_type = lookup_media(media)
+      "application/vnd.github.#{version}.#{media_type}"
     end
 
-    def _normalize_name(name)
-      puts "NAME: #{name}"
-      case name
-      when String
-        name.strip.downcase.to_sym
-      when Symbol
-        name
-      else
-        raise ArgumentError, 'Provided MIME Type is not a valid or recognized entry'
+    def lookup_media(name)
+      MEDIA_LOOKUP.fetch(name) do
+        raise ArgumentError, "Provided Media Type #{name} is not valid"
       end
     end