github_api 0.11.2 → 0.11.3

data/features/cassettes/repos/pages/list_builds.yml

@@ -0,0 +1,63 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/repos/<USER>/github_api_test/pages/builds?access_token=<TOKEN>
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      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: 
+      - Github Ruby Gem 0.11.2
+      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: 
+      - Sun, 16 Feb 2014 19:13:30 GMT
+      Content-Type: 
+      - application/json; charset=utf-8
+      Status: 
+      - 200 OK
+      X-Ratelimit-Limit: 
+      - "5000"
+      X-Ratelimit-Remaining: 
+      - "4987"
+      X-Ratelimit-Reset: 
+      - "1392579836"
+      Cache-Control: 
+      - private, max-age=60, s-maxage=60
+      Etag: 
+      - "\"be2b47a6aa91c255a63bbfbd08983b13\""
+      Vary: 
+      - Accept, Authorization, Cookie, X-GitHub-OTP
+      - Accept-Encoding
+      X-Github-Media-Type: 
+      - github.v3; format=json
+      X-Content-Type-Options: 
+      - nosniff
+      Content-Length: 
+      - "2"
+      Access-Control-Allow-Credentials: 
+      - "true"
+      Access-Control-Expose-Headers: 
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin: 
+      - "*"
+      X-Github-Request-Id: 
+      - 4D649864:435B:232290A:53010DDA
+    body: 
+      encoding: US-ASCII
+      string: "[]"
+    http_version: 
+  recorded_at: Sun, 16 Feb 2014 19:13:30 GMT
+recorded_with: VCR 2.6.0

data/features/cassettes/repos/pages/list_latest_builds.yml

@@ -0,0 +1,62 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/repos/<USER>/github_api_test/pages/builds/latest?access_token=<TOKEN>
+    body: 
+      encoding: US-ASCII
+      string: ""
+    headers: 
+      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: 
+      - Github Ruby Gem 0.11.2
+      Accept-Encoding: 
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response: 
+    status: 
+      code: 404
+      message: Not Found
+    headers: 
+      Server: 
+      - GitHub.com
+      Date: 
+      - Sun, 16 Feb 2014 19:21:04 GMT
+      Content-Type: 
+      - application/json; charset=utf-8
+      Transfer-Encoding: 
+      - chunked
+      Status: 
+      - 404 Not Found
+      X-Ratelimit-Limit: 
+      - "5000"
+      X-Ratelimit-Remaining: 
+      - "4983"
+      X-Ratelimit-Reset: 
+      - "1392579836"
+      X-Github-Media-Type: 
+      - github.v3; format=json
+      X-Content-Type-Options: 
+      - nosniff
+      Access-Control-Allow-Credentials: 
+      - "true"
+      Access-Control-Expose-Headers: 
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin: 
+      - "*"
+      X-Github-Request-Id: 
+      - 4D649864:435B:233DE61:53010FA0
+      Content-Encoding: 
+      - gzip
+    body: 
+      encoding: ASCII-8BIT
+      string: !binary |
+        H4sIAAAAAAAAA6tWyk0tLk5MT1WyUvLLL1Fwyy/NS1HSUUrJTy7NTc0rSSzJ
+        zM+LLy3KAcpnlJQUWOnrp6SWpebkF6QW6aVnlmSUJukl5+fqlxkr1QIARorx
+        tEwAAAA=
+
+    http_version: 
+  recorded_at: Sun, 16 Feb 2014 19:21:04 GMT
+recorded_with: VCR 2.6.0

data/features/repos/pages.feature

@@ -0,0 +1,24 @@
+Feature: Pages API
+
+  Background:
+    Given I have "Github::Repos::Pages" instance
+
+  Scenario: List builds
+
+    Given I want to list resources with the following params:
+      | owner | repo            |
+      | murek | github_api_test |
+    When I make request within a cassette named "repos/pages/list_builds"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should be empty
+
+  Scenario: Get
+
+    Given I want to get resource with the following params:
+      | owner | repo            |
+      | murek | github_api_test |
+    When I make request within a cassette named "repos/pages/get"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty

data/features/settings.yml

@@ -0,0 +1,7 @@
+---
+oauth_token: 4b1de666ad20cc8ed75a96177db7f2e8530ecc2a
+basic_auth: murek:Testing123
+user: murek
+repo: github_api_test
+org: organisation this user belongs to
+email: username@example.com

data/lib/github_api.rb

@@ -7,7 +7,6 @@ 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'
 require 'github_api/ext/faraday'
 
 module Github

data/lib/github_api/authorizations.rb

@@ -5,6 +5,8 @@ module Github
   # OAuth Authorizations API
   class Authorizations < API
 
+    Github::require_all 'github_api/authorizations', 'app'
+
     VALID_AUTH_PARAM_NAMES = %w[
       scopes
       add_scopes
@@ -15,15 +17,21 @@ module Github
       client_secret
     ].freeze
 
+    # Access to Authorizations::App API
+    def app(options={}, &block)
+      @app ||= ApiFactory.new('Authorizations::App', current_options.merge(options), &block)
+    end
+
     # List authorizations
     #
-    # = Examples
-    #  github = Github.new :basic_auth => 'login:password'
+    # @example
+    #  github = Github.new basic_auth: 'login:password'
     #  github.oauth.list
     #  github.oauth.list { |auth| ... }
     #
+    # @api public
     def list(*args)
-      _check_if_authenticated
+      raise_authentication_error unless authenticated?
       arguments(args)
 
       response = get_request('/authorizations', arguments.params)
@@ -34,12 +42,15 @@ module Github
 
     # Get a single authorization
     #
-    # = Examples
-    #  github = Github.new :basic_auth => 'login:password'
+    # @example
+    #  github = Github.new basic_auth: 'login:password'
     #  github.oauth.get 'authorization-id'
     #
+    # @return [ResponseWrapper]
+    #
+    # @api public
     def get(*args)
-      _check_if_authenticated
+      raise_authentication_error unless authenticated?
       arguments(args, required: [:authorization_id])
 
       get_request("/authorizations/#{authorization_id}", arguments.params)
@@ -48,18 +59,26 @@ module Github
 
     # Create a new authorization
     #
-    # = Inputs
-    # * <tt>:scopes</tt> - Optional array - A list of scopes that this authorization is in.
-    # * <tt>:note</tt> - Optional string - A note to remind you what the OAuth token is for.
-    # * <tt>:note_url</tt> - Optional string - A URL to remind you what the OAuth token is for.
+    # @param [Hash] params
+    # @option params [Array[String]] :scopes
+    #   A list of scopes that this authorization is in.
+    # @option params [String] :note
+    #   A note to remind you what the OAuth token is for.
+    # @option params [String] :note_url
+    #   A URL to remind you what the OAuth token is for.
+    # @option params [String] :client_id
+    #   The 20 character OAuth app client key for which to create the token.
+    # @option params [String] :client_secret
+    #   The 40 character OAuth app client secret for which to create the token.
     #
-    # = Examples
-    #  github = Github.new :basic_auth => 'login:password'
+    # @example
+    #  github = Github.new basic_auth: 'login:password'
     #  github.oauth.create
     #    "scopes" => ["public_repo"]
     #
+    # @api public
     def create(*args)
-      _check_if_authenticated
+      raise_authentication_error unless authenticated?
       arguments(args) do
         sift VALID_AUTH_PARAM_NAMES
       end
@@ -69,19 +88,25 @@ module Github
 
     # Update an existing authorization
     #
-    # = Inputs
-    # * <tt>:scopes</tt> - Optional array - A list of scopes that this authorization is in.
-    # * <tt>:add_scopes</tt> - Optional array - A list of scopes to add to this authorization.
-    # * <tt>:remove_scopes</tt> - Optional array - A list of scopes to remove from this authorization.
-    # * <tt>:note</tt> - Optional string - A note to remind you what the OAuth token is for.
-    # * <tt>:note_url</tt> - Optional string - A URL to remind you what the OAuth token is for.
+    # @param [Hash] inputs
+    # @option inputs [Array] :scopes
+    #   Optional array - A list of scopes that this authorization is in.
+    # @option inputs [Array] :add_scopes
+    #   Optional array - A list of scopes to add to this authorization.
+    # @option inputs [Array] :remove_scopes
+    #   Optional array - A list of scopes to remove from this authorization.
+    # @option inputs [String] :note
+    #   Optional string - A note to remind you what the OAuth token is for.
+    # @optoin inputs [String] :note_url
+    #   Optional string - A URL to remind you what the OAuth token is for.
     #
-    # = Examples
-    #  github = Github.new :basic_auth => 'login:password'
-    #  github.oauth.update "authorization-id", "add_scopes" => ["repo"],
+    # @example
+    #  github = Github.new basic_auth: 'login:password'
+    #  github.oauth.update "authorization-id", add_scopes: ["repo"]
     #
+    # @api public
     def update(*args)
-      _check_if_authenticated
+      raise_authentication_error unless authenticated?
       arguments(args, required: [:authorization_id]) do
         sift VALID_AUTH_PARAM_NAMES
       end
@@ -92,34 +117,23 @@ module Github
 
     # Delete an authorization
     #
-    # = Examples
+    # @example
     #  github.oauth.delete 'authorization-id'
     #
+    # @api public
     def delete(*args)
-      _check_if_authenticated
+      raise_authentication_error unless authenticated?
       arguments(args, required: [:authorization_id])
 
       delete_request("/authorizations/#{authorization_id}", arguments.params)
     end
     alias :remove :delete
 
-    # Revoke all authorizations for an application
-    #
-    # = Examples
-    #  github = Github.new basic_auth: "client_id:client_secret"
-    #  github.oauth.revoke 'client-id'
-    #
-    #
-    def revoke(*args)
-      
-    end
-
-    private
+    protected
 
-    def _check_if_authenticated
-      unless authenticated?
-        raise ArgumentError, 'You can only access your own tokens via Basic Authentication'
-      end
+    def raise_authentication_error
+      raise ArgumentError, 'You can only access your own tokens' +
+        ' via Basic Authentication'
     end
 
   end # Authorizations

data/lib/github_api/authorizations/app.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+module Github
+
+  class Authorizations::App < Authorizations
+
+    # Get-or-create an authorization for a specific app
+    #
+    # @param [Hash] params
+    # @option params [String] client_secret
+    #  The 40 character OAuth app client secret associated with the client
+    #  ID specified in the URL.
+    # @option params [Array] :scopes
+    #   Optional array - A list of scopes that this authorization is in.
+    # @option params [String] :note
+    #   Optional string - A note to remind you what the OAuth token is for.
+    # @option params [String] :note_url
+    #   Optional string - A URL to remind you what the OAuth token is for.
+    #
+    # @example
+    #   github = Github.new
+    #   github.oauth.app.create 'client-id', client_secret: '...'
+    #
+    # @api public
+    def create(*args)
+      raise_authentication_error unless authenticated?
+      arguments(args, required: [:client_id]) do
+        sift Authorizations::VALID_AUTH_PARAM_NAMES
+      end
+
+      if client_id
+        put_request("/authorizations/clients/#{client_id}", arguments.params)
+      else
+        raise raise_app_authentication_error
+      end
+    end
+
+    # Revoke all authorizations for an application
+    #
+    # @example
+    #  github = Github.new basic_auth: "client_id:client_secret"
+    #  github.oauth.app.delete 'client-id'
+    #
+    # Revoke an authorization for an application
+    #
+    # @example
+    #
+    #  github = Github.new basic_auth: "client_id:client_secret"
+    #  github.oauth.app.delete 'client-id', 'access-token'
+    #
+    # @api public
+    def delete(*args)
+      raise_authentication_error unless authenticated?
+      params = arguments(args, required: [:client_id]).params
+
+      if client_id
+        if access_token = (params.delete('access_token') || args[1])
+          delete_request("/applications/#{client_id}/tokens/#{access_token}", params)
+        else
+          # Revokes all tokens
+          delete_request("/applications/#{client_id}/tokens", params)
+        end
+      else
+        raise raise_app_authentication_error
+      end
+    end
+    alias :remove :delete
+    alias :revoke :delete
+
+    protected
+
+    def raise_app_authentication_error
+      raise ArgumentError, 'To create authorization for the app, ' +
+        'you need to provide client_id argument and client_secret parameter'
+    end
+  end
+end

data/lib/github_api/core_ext/array.rb

@@ -1,17 +1,25 @@
+# encoding: utf-8
+
 class Array # :nodoc:
 
-  def except(*keys) # :nodoc:
+  # Returns a new arrray with keys removed
+  #
+  def except(*keys)
     self.dup.except!(*keys)
-  end unless method_defined?(:except)
+  end unless method_defined? :except
 
-  def except!(*items) # :nodoc:
+  # Similar to except but modifies self
+  #
+  def except!(*items)
     copy = self.dup
     copy.reject! { |item| items.include? item }
     copy
-  end unless method_defined?(:except!)
+  end unless method_defined? :except!
 
+  # Selects a hash from the arguments list
+  #
   def extract_options!
     last.is_a?(::Hash) ? pop : {}
-  end
+  end unless method_defined? :extract_options!
 
 end # Array

data/lib/github_api/core_ext/hash.rb

@@ -1,23 +1,33 @@
+# encoding: utf-8
+
 class Hash # :nodoc:
 
-  def except(*items) # :nodoc:
+  # Returns a new hash with keys removed
+  #
+  def except(*items)
     self.dup.except!(*items)
-  end unless method_defined?(:except)
+  end unless method_defined? :except
 
-  def except!(*keys) # :nodoc:
+  # Similar to except but modifies self
+  #
+  def except!(*keys)
     copy = self.dup
     keys.each { |key| copy.delete!(key) }
     copy
-  end unless method_defined?(:except!)
+  end unless method_defined? :except!
 
-  def symbolize_keys  # :nodoc:
+  # Returns a new hash with all the keys converted to symbols
+  #
+  def symbolize_keys
     inject({}) do |hash, (key, value)|
       hash[(key.to_sym rescue key) || key] = value
       hash
     end
-  end unless method_defined?(:symbolize_keys)
+  end unless method_defined? :symbolize_keys
 
-  def symbolize_keys! # :nodoc:
+  # Similar to symbolize_keys but modifies self
+  #
+  def symbolize_keys!
     hash = symbolize_keys
     hash.each do |key, val|
       hash[key] = case val
@@ -32,42 +42,51 @@ class Hash # :nodoc:
         end
     end
     return hash
-  end unless method_defined?(:symbolize_keys!)
+  end unless method_defined? :symbolize_keys!
 
-  def serialize # :nodoc:
+  # Returns hash collapsed into a query string
+  #
+  def serialize
     self.map { |key, val| [key, val].join("=") }.join("&")
-  end unless method_defined?(:serialize)
+  end unless method_defined? :serialize
 
-  def all_keys # :nodoc:
+  # Searches for all deeply nested keys
+  #
+  def deep_keys
     keys = self.keys
     keys.each do |key|
       if self[key].is_a?(Hash)
-        keys << self[key].all_keys.compact.flatten
+        keys << self[key].deep_keys.compact.flatten
         next
       end
     end
     keys.flatten
-  end unless method_defined?(:all_keys)
+  end unless method_defined? :deep_keys
 
-  def has_deep_key?(key)
-    self.all_keys.include? key
-  end unless method_defined?(:has_deep_key?)
+  # Returns true if the given key is present inside deeply nested hash
+  #
+  def deep_key?(key)
+    self.deep_keys.include? key
+  end unless method_defined? :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
+  # Recursively merges self with other hash and returns new hash.
+  #
+  def deep_merge(other, &block)
+    dup.deep_merge!(other, &block)
+  end unless method_defined? :deep_merge
+
+  # Similar as deep_merge but modifies self
+  #
+  def deep_merge!(other, &block)
+    other.each_pair do |key, val|
+      tval = self[key]
+      if tval.is_a?(Hash) && val.is_a?(Hash)
+        self[key] = tval.deep_merge(val)
+      else
+        self[key] = block && tval ? block.call(k, tval, val) : val
       end
     end
-    return hash
-  end
+    self
+  end unless method_defined? :deep_merge!
 
 end # Hash