github_api 0.13.0 → 0.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a71c5d538e4a0188b7991e64d288552324618f74
-  data.tar.gz: 912f75917c8be1cbce0eec32496a6f15eca9c6c1
+  metadata.gz: 6826e6aa63062a779729043a6e29bf543e53eb13
+  data.tar.gz: cd5c5dafd529f688fc8ec51693bad0a6fff24912
 SHA512:
-  metadata.gz: ddda23aac44bc2a628e0d100458f583615324c4fc7cab05da43ec886a9e087581a09faedbbcfef7c2db75fe2d8c4ea1dde3c1eadd2c5f2971bf2406d4829bf1e
-  data.tar.gz: e5f063e110e1f3b94b2e9d7fba6dae3cf6209c692b315cd2e33d992520d1d2dff70d35fbc4a388eab652d246ce17735b024366e4d873961bb3cd0ba99d028fb6
+  metadata.gz: 3bfd3e4f3a4dbbb82090b52d20ff2606609fe0b3dda8d838e7dff3258518c88955308ae9a87ffa46f613b5a5d32bda58e020b83089f9483dddf601f340addfbf
+  data.tar.gz: 46e9bc11f2d8021f9640c37720b0022134c766f4313ddbcd103efa441b895773a8720733c0bf39ac4dd102987aefb4a41375f2b4b34d78ad10a6d570027b2712

data/README.md

@@ -7,7 +7,7 @@
 [![Code Climate](https://codeclimate.com/github/peter-murach/github/badges/gpa.svg)][codeclimate]
 [![Coverage Status](https://coveralls.io/repos/peter-murach/github/badge.svg?branch=master)][coverage]
 [![Inline docs](http://inch-ci.org/github/peter-murach/github.svg)][inchpages]
-[![Dependency Status](https://gemnasium.com/peter-murach/github.png?travis)][gemnasium]
+[![Dependency Status](https://gemnasium.com/peter-murach/github.svg?travis)][gemnasium]
 
 [gem]: http://badge.fury.io/rb/github_api
 [travis]: http://travis-ci.org/peter-murach/github
@@ -293,6 +293,7 @@ Alternatively, you can configure the settings by passing a block to an instance
 Github.new do |c|
   c.endpoint    = 'https://github.company.com/api/v3'
   c.site        = 'https://github.company.com'
+  c.upload_endpoint = 'https://github.company.com/api/uploads'
 end
 ```
 
@@ -563,13 +564,13 @@ github = Github.new auto_pagination: true
 Depending at what stage you pass the `auto_pagination` it will affect all or only a single request. For example, in order to auto paginate all Repository API methods do:
 
 ```ruby
-Github::Repos.new auto_pagination: true
+Github::Сlient::Repos.new auto_pagination: true
 ```
 
 However, to only auto paginate results for a single request do:
 
 ```ruby
-Github::Repos.new.list user: '...', auto_pagination: true
+Github::Client::Repos.new.list user: '...', auto_pagination: true
 ```
 
 ## 5 Error Handling
@@ -609,9 +610,9 @@ class GithubController < ApplicationController
     access_token = github.get_token authorization_code
     access_token.token   # => returns token value
   end
-  
+
   private
-  
+
    def github
     @github ||= Github.new client_id: '...', client_secret: '...'
    end

data/lib/github_api/client/activity.rb

@@ -6,6 +6,7 @@ module Github
     require_all 'github_api/client/activity',
       'events',
       'notifications',
+      'feeds',
       'starring',
       'watching'
 
@@ -15,6 +16,9 @@ module Github
     # Access to Activity::Notifications API
     namespace :notifications
 
+    # Access to Activity::Feeds API
+    namespace :feeds
+
     # Access to Activity::Starring API
     namespace :starring
 

data/lib/github_api/client/activity/events.rb

@@ -2,9 +2,10 @@
 
 module Github
   class Client::Activity::Events < API
-
     # List all public events
     #
+    # @see https://developer.github.com/v3/activity/events/#list-public-events
+    #
     # @example
     #  github = Github.new
     #  github.activity.events.public
@@ -18,9 +19,9 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :public_events :public
-    alias :list_public :public
-    alias :list_public_events :public
+    alias_method :public_events, :public
+    alias_method :list_public, :public
+    alias_method :list_public_events, :public
 
     # List all repository events for a given user
     #
@@ -41,10 +42,10 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :repos :repository
-    alias :repo_events :repository
-    alias :repository_events :repository
-    alias :list_repository_events :repository
+    alias_method :repos,                  :repository
+    alias_method :repo_events,            :repository
+    alias_method :repository_events,      :repository
+    alias_method :list_repository_events, :repository
 
     # List all issue events for a given repository
     #
@@ -65,12 +66,14 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :issues :issue
-    alias :issue_events :issue
-    alias :list_issue_events :issue
+    alias_method :issues,            :issue
+    alias_method :issue_events,      :issue
+    alias_method :list_issue_events, :issue
 
     # List all public events for a network of repositories
     #
+    # @see https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories
+    #
     # @example
     #   github = Github.new
     #   github.activity.events.network 'user-name', 'repo-name'
@@ -88,13 +91,15 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :repo_network :network
-    alias :repository_network :network
-    alias :list_repo_network_events :network
-    alias :list_repository_network_events :network
+    alias_method :repo_network,                   :network
+    alias_method :repository_network,             :network
+    alias_method :list_repo_network_events,       :network
+    alias_method :list_repository_network_events, :network
 
     # List all public events for an organization
     #
+    # @see https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization
+    #
     # @example
     #   github = Github.new
     #   github.activity.events.org 'org-name'
@@ -112,13 +117,15 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :organization :org
-    alias :list_orgs :org
-    alias :list_org_events :org
-    alias :list_organization_events :org
+    alias_method :organization,             :org
+    alias_method :list_orgs,                :org
+    alias_method :list_org_events,          :org
+    alias_method :list_organization_events, :org
 
     # List all events that a user has received
     #
+    # @see https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received
+    #
     # These are events that you’ve received by watching repos
     # and following users. If you are authenticated as the given user,
     # you will see private events. Otherwise, you’ll only see public events.
@@ -130,6 +137,8 @@ module Github
     #
     # List all public events that a user has received
     #
+    # @see https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received
+    #
     # @example
     #   github = Github.new
     #   github.activity.events.received 'user-name', public: true
@@ -149,11 +158,13 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :user_received :received
-    alias :list_user_received :received
+    alias_method :user_received,      :received
+    alias_method :list_user_received, :received
 
     # List all events that a user has performed
     #
+    # @see https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user
+    #
     # If you are authenticated as the given user, you will see your private
     # events. Otherwise, you’ll only see public events.
     #
@@ -164,6 +175,8 @@ module Github
     #
     # List all public events that a user has performed
     #
+    # @see https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user
+    #
     # @example
     #   github = Github.new
     #   github.activity.events.performed 'user-name', public: true
@@ -183,12 +196,14 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :user_performed :performed
-    alias :list_user_performed :performed
+    alias_method :user_performed,      :performed
+    alias_method :list_user_performed, :performed
 
     # List all events for an organization
     #
-    # This is the user’s organization dashboard. You must be authenticated
+    # @see https://developer.github.com/v3/activity/events/#list-events-for-an-organization
+    #
+    # This is the user's organization dashboard. You must be authenticated
     # as the user to view this.
     #
     # @example
@@ -208,9 +223,9 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :user_organization :user_org
-    alias :list_user_org :user_org
-    alias :list_user_org_events :user_org
-    alias :list_user_organization_events :user_org
+    alias_method :user_organization,             :user_org
+    alias_method :list_user_org,                 :user_org
+    alias_method :list_user_org_events,          :user_org
+    alias_method :list_user_organization_events, :user_org
   end # Client::Activity::Events
 end # Github

data/lib/github_api/client/activity/feeds.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+module Github
+  class Client::Activity::Feeds < API
+
+    # List all the feeds available to the authenticated user.
+    #
+    # @see https://developer.github.com/v3/activity/feeds/#list-feeds
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.feeds.list
+    #
+    # @api public
+    def list(*args)
+      arguments(args)
+
+      response = get_request("/feeds", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :all, :list
+
+    # Get all the items for a named timeline
+    #
+    # @see https://developer.github.com/v3/activity/feeds/#list-feeds
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.feeds.get "timeline"
+    #
+    # @param [String] name
+    #   the name of the timeline resource
+    #
+    # @api public
+    def get(*args)
+      arguments(args, required: [:name])
+
+      name = arguments.name
+      response = list.body._links[name]
+      if response
+        params = arguments.params
+        params['accept'] = response.type
+        get_request(response.href, params)
+      end
+    end
+    alias_method :find, :get
+  end
+end # Github

data/lib/github_api/client/activity/notifications.rb

@@ -35,21 +35,19 @@ module Github
     #
     # @api public
     def list(*args)
-      arguments(args) do
-        permit %w[ all participating since user repo]
-      end
+      arguments(args)
       params = arguments.params
 
-      response = if ( (user_name = params.delete("user")) &&
-                      (repo_name = params.delete("repo")) )
+      response = if ( (user_name = params.delete('user')) &&
+                      (repo_name = params.delete('repo')) )
         get_request("/repos/#{user_name}/#{repo_name}/notifications", params)
       else
-        get_request("/notifications", params)
+        get_request('/notifications', params)
       end
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # View a single thread
     #
@@ -62,13 +60,13 @@ module Github
     #
     # @api public
     def get(*args)
-      arguments(args, required: [:id])
+      arguments(args, required: [:thread_id])
 
-      response = get_request("/notifications/threads/#{arguments.id}", arguments.params)
+      response = get_request("/notifications/threads/#{arguments.thread_id}", arguments.params)
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :find :get
+    alias_method :find, :get
 
     # Mark as read
     #
@@ -103,19 +101,17 @@ module Github
     #
     # @api public
     def mark(*args)
-      arguments(args) do
-        permit %w[ unread read last_read_at user repo id]
-      end
+      arguments(args)
       params = arguments.params
 
-      if ( (user_name = params.delete("user")) &&
-           (repo_name = params.delete("repo")) )
+      if ( (user_name = params.delete('user')) &&
+           (repo_name = params.delete('repo')) )
 
         put_request("/repos/#{user_name}/#{repo_name}/notifications", params)
       elsif (thread_id = params.delete("id"))
         patch_request("/notifications/threads/#{thread_id}", params)
       else
-        put_request("/notifications", params)
+        put_request('/notifications', params)
       end
     end
 
@@ -132,9 +128,9 @@ module Github
     #
     # @api public
     def subscribed?(*args)
-      arguments(args, required: [:id])
+      arguments(args, required: [:thread_id])
 
-      get_request("/notifications/threads/#{arguments.id}/subscription", arguments.params)
+      get_request("/notifications/threads/#{arguments.thread_id}/subscription", arguments.params)
     end
 
     # Create a thread subscription
@@ -160,9 +156,9 @@ module Github
     #
     # @api public
     def create(*args)
-      arguments(args, required: [:id])
+      arguments(args, required: [:thread_id])
 
-      put_request("/notifications/threads/#{arguments.id}/subscription", arguments.params)
+      put_request("/notifications/threads/#{arguments.thread_id}/subscription", arguments.params)
     end
 
     # Delete a thread subscription
@@ -175,10 +171,10 @@ module Github
     #
     # @api public
     def delete(*args)
-      arguments(args, required: [:id])
+      arguments(args, required: [:thread_id])
 
-      delete_request("/notifications/threads/#{arguments.id}/subscription", arguments.params)
+      delete_request("/notifications/threads/#{arguments.thread_id}/subscription", arguments.params)
     end
-    alias :remove :delete
+    alias_method :remove, :delete
   end # Client::Activity::Notifications
 end # Github

data/lib/github_api/client/activity/starring.rb

@@ -2,7 +2,8 @@
 
 module Github
   # Repository Starring is a feature that lets users bookmark repositories.
-  # Stars are shown next to repositories to show an approximate level of interest.  # Stars have no effect on notifications or the activity feed.
+  # Stars are shown next to repositories to show an approximate level of interest.
+  # Stars have no effect on notifications or the activity feed.
   class Client::Activity::Starring < API
     # List stargazers
     #
@@ -21,7 +22,7 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # List repos being starred by a user
     #
@@ -54,7 +55,7 @@ module Github
       response = if (user_name = params.delete('user'))
         get_request("/users/#{user_name}/starred", params)
       else
-        get_request("/user/starred", params)
+        get_request('/user/starred', params)
       end
       return response unless block_given?
       response.each { |el| yield el }
@@ -62,7 +63,6 @@ module Github
 
     # Check if you are starring a repository
     #
-    #
     # @see https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository
     #
     # @example

data/lib/github_api/client/activity/watching.rb

@@ -2,7 +2,7 @@
 
 module Github
   # Watching a Repository registers the user to receive notificactions on new
-  # discussions, as well as events in the user’s activity feed.
+  # discussions, as well as events in the user's activity feed.
   class Client::Activity::Watching < API
     # List repository watchers
     #
@@ -21,7 +21,7 @@ module Github
       return response unless block_given?
       response.each { |el| yield el }
     end
-    alias :all :list
+    alias_method :all, :list
 
     # List repos being watched by a user
     #
@@ -45,7 +45,7 @@ module Github
       response = if (user_name = params.delete('user'))
         get_request("/users/#{user_name}/subscriptions", params)
       else
-        get_request("/user/subscriptions", params)
+        get_request('/user/subscriptions', params)
       end
       return response unless block_given?
       response.each { |el| yield el }

data/lib/github_api/client/repos/releases/assets.rb

@@ -70,7 +70,7 @@ module Github
       file = Faraday::UploadIO.new(arguments.filepath, type)
       options = {
         headers: { content_type: type },
-        endpoint: 'https://uploads.github.com',
+        endpoint: upload_endpoint,
         query: {'name' => params['name']}
       }
       params['data']    = file.read

data/lib/github_api/configuration.rb

@@ -30,6 +30,9 @@ module Github
     # The web endpoint used to connect to GitHub if none is set
     property  :site, default: 'https://github.com'.freeze
 
+    # The web endpoint used to upload release assets to GitHub if none is set
+    property  :upload_endpoint, default: 'https://uploads.github.com'.freeze
+
     # The default SSL configuration
     property  :ssl, default: {
       :ca_file => File.expand_path('../ssl_certs/cacerts.pem', __FILE__)

data/lib/github_api/middleware.rb

@@ -3,6 +3,7 @@
 require 'github_api/response'
 require 'github_api/response/mashify'
 require 'github_api/response/jsonize'
+require 'github_api/response/atom_parser'
 require 'github_api/response/raise_error'
 require 'github_api/response/header'
 
@@ -21,6 +22,7 @@ module Github
         unless options[:raw]
           builder.use Github::Response::Mashify
           builder.use Github::Response::Jsonize
+          builder.use Github::Response::AtomParser
         end
         builder.use Github::Response::RaiseError
         builder.adapter options[:adapter]

data/lib/github_api/response.rb

@@ -16,13 +16,33 @@ module Github
       @parser = block
     end
 
+    def initialize(app, options = {})
+      super(app)
+      @content_types = Array(options[:content_type])
+    end
+
+    def process_body(env)
+      env[:body] = parse(env[:body])
+    end
+
+    def parse_body?(env)
+      parse_response_type?(response_type(env)) and parse_response?(env)
+    end
+
     def response_type(env)
-      env[:response_headers][CONTENT_TYPE].to_s
+      type = env[:response_headers][CONTENT_TYPE].to_s
+      type = type.split(';', 2).first if type.index(';')
+      type
     end
 
-    def parse_response?(env)
-      env[:body].respond_to? :to_str
+    def parse_response_type?(type)
+      @content_types.empty? || @content_types.any? { |pattern|
+        pattern.is_a?(Regexp) ? type =~ pattern : type == pattern
+      }
     end
 
+    def parse_response?(env)
+      env[:body].respond_to?(:to_str)
+    end
   end # Response
 end # Github

data/lib/github_api/response/atom_parser.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Response::AtomParser < Response
+    define_parser do |body|
+      require 'rss'
+      RSS::Parser.parse(body)
+    end
+
+    def initialize(app, options = {})
+      super(app, options.merge(content_type: /(\batom|\brss)/))
+    end
+
+    def on_complete(env)
+      if parse_body?(env)
+        process_body(env)
+      end
+    end
+  end
+end

data/lib/github_api/response/xmlize.rb

@@ -4,6 +4,7 @@ require 'faraday'
 
 module Github
   class Response::Xmlize < Response
+
     dependency 'nokogiri'
 
     define_parser do |body|
@@ -19,7 +20,7 @@ module Github
       when 'false'
         false
       else
-        self.class.parser.call body
+        self.class.parser.call(body)
       end
     end
   end # Response::Xmlize

data/lib/github_api/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Github
-  VERSION = "0.13.0"
+  VERSION = "0.13.1"
 end # Github

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: github_api
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-21 00:00:00.000000000 Z
+date: 2015-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -93,47 +93,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: descendants_tracker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: 0.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.6
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
-  name: descendants_tracker
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.4
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 description: ' Ruby client that supports all of the GitHub API methods. 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::Client::Repos.new if working solely with repositories
@@ -154,6 +154,7 @@ files:
 - lib/github_api/api.rb
 - lib/github_api/authorization.rb
 - lib/github_api/client/activity/events.rb
+- lib/github_api/client/activity/feeds.rb
 - lib/github_api/client/activity/notifications.rb
 - lib/github_api/client/activity/starring.rb
 - lib/github_api/client/activity/watching.rb
@@ -254,6 +255,7 @@ files:
 - lib/github_api/request.rb
 - lib/github_api/requestable.rb
 - lib/github_api/resource.rb
+- lib/github_api/response/atom_parser.rb
 - lib/github_api/response/header.rb
 - lib/github_api/response/jsonize.rb
 - lib/github_api/response/mashify.rb