lingfennan-github_api 0.18.2

data/lib/github_api/api/config/property_set.rb

@@ -0,0 +1,120 @@
+# encoding: utf-8
+
+require 'set'
+
+module Github
+  class API
+    class Config
+      # Class responsible for storing configuration properties
+      class PropertySet
+        include Enumerable
+
+        attr_reader :parent
+
+        attr_reader :properties
+
+        # Initialize an PropertySet
+        #
+        # @param [Object] parent
+        # @param [Set] properties
+        #
+        # @return [undefined]
+        #
+        # @api private
+        def initialize(parent = nil, properties = Set.new)
+          @parent = parent
+          @properties = properties
+          @map = {}
+        end
+
+        # Iterate over properties
+        #
+        # @yield [property]
+        #
+        # @yieldparam [Property] property
+        #
+        # @return [self]
+        #
+        # @api public
+        def each
+          return to_enum unless block_given?
+          @map.each { |name, property| yield property if name.is_a?(Symbol) }
+          self
+        end
+
+        # Adds property to the set
+        #
+        # @example
+        #   properties_set << property
+        #
+        # @param [Property] property
+        #
+        # @return [self]
+        #
+        # @api public
+        def <<(property)
+          properties << property
+          update_map(property.name, property.default)
+          property.define_accessor_methods(self)
+          self
+        end
+
+        # Access property by name
+        #
+        # @api public
+        def [](name)
+          @map[name]
+        end
+        alias_method :fetch, :[]
+
+        # Set property value by name
+        #
+        # @api public
+        def []=(name, property)
+          update_map(name, property)
+        end
+
+        # Update map with index
+        #
+        # @api private
+        def update_map(name, property)
+          @map[name.to_sym] = @map[name.to_s.freeze] = property
+        end
+
+        # Convert properties to a hash of property names and
+        # corresponding values
+        #
+        # @api public
+        def to_hash
+          properties.each_with_object({}) do |property, props|
+            name = property.name
+            props[name] = self[name]
+          end
+        end
+
+        # Check if properties exist
+        #
+        # @api public
+        def empty?
+          @map.empty?
+        end
+
+        # @api private
+        def define_reader_method(property, method_name, visibility)
+          property_set = self
+          parent.send(:define_method, method_name) { property_set[property.name] }
+          parent.send(visibility, method_name)
+        end
+
+        # @api private
+        def define_writer_method(property, method_name, visibility)
+          property_set = self
+          parent.send(:define_method, method_name) do |value|
+            property_set[property.name]= value
+          end
+          parent.send(visibility, method_name)
+        end
+      end # PropertySet
+    end # Config
+  end # Api
+end # Github

data/lib/github_api/api/factory.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'github_api/core_ext/hash'
+
+module Github
+  class API
+    class Factory
+
+      # Instantiates a new github api object
+      #
+      def self.new(klass, options={}, &block)
+        return create_instance(klass, options, &block) if klass
+        raise ArgumentError, 'must provide API class to be instantiated'
+      end
+
+      # Passes configuration options to instantiated class
+      #
+      def self.create_instance(klass, options, &block)
+        options.symbolize_keys!
+        convert_to_constant(klass.to_s).new options, &block
+      end
+
+      # Convert name to constant
+      #
+      def self.convert_to_constant(classes)
+        classes.split('::').inject(Github) do |constant, klass|
+          constant.const_get klass
+        end
+      end
+
+    end # Factory
+  end # Api
+end # Github

data/lib/github_api/authorization.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+require 'oauth2'
+
+module Github
+  module Authorization
+
+    # Setup OAuth2 instance
+    def client
+      @client ||= ::OAuth2::Client.new(client_id, client_secret,
+        {
+          :site          => current_options.fetch(:site) { Github.site },
+          :authorize_url => 'login/oauth/authorize',
+          :token_url     => 'login/oauth/access_token',
+          :ssl           => { :verify => false }
+        }
+      )
+    end
+
+    # Strategy token
+    def auth_code
+      _verify_client
+      client.auth_code
+    end
+
+    # Sends authorization request to GitHub.
+    # = Parameters
+    # * <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).
+    #   * <tt>user</tt> - DB read/write access to profile info only.
+    #   * <tt>public_repo</tt> - DB read/write access, and Git read access to public repos.
+    #   * <tt>repo</tt> - DB read/write access, and Git read access to public and private repos.
+    #   * <tt>gist</tt> - write access to gists.
+    #
+    def authorize_url(params = {})
+      _verify_client
+      client.auth_code.authorize_url(params)
+    end
+
+    # Makes request to token endpoint and retrieves access token value
+    def get_token(authorization_code, params = {})
+      _verify_client
+      client.auth_code.get_token(authorization_code, params)
+    end
+
+    # Check whether authentication credentials are present
+    def authenticated?
+      basic_authed? || oauth_token?
+    end
+
+    # Check whether basic authentication credentials are present
+    def basic_authed?
+      basic_auth? || (login? && password?)
+    end
+
+    # Select authentication parameters
+    #
+    # @api public
+    def authentication
+      if basic_authed?
+        { login: login, password: password }
+      else
+        {}
+      end
+    end
+
+    private
+
+    def _verify_client # :nodoc:
+      raise ArgumentError, 'Need to provide client_id and client_secret' unless client_id? && client_secret?
+    end
+  end # Authorization
+end # Github

data/lib/github_api/client.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+require_relative 'api'
+
+module Github
+  class Client < API
+    require_all 'github_api/client',
+                'activity',
+                'authorizations',
+                'emojis',
+                'gists',
+                'gitignore',
+                'git_data',
+                'issues',
+                'markdown',
+                'meta',
+                'orgs',
+                'projects',
+                'pull_requests',
+                'repos',
+                'say',
+                'scopes',
+                'search',
+                'users'
+
+    # Serving up the 'social' in Social Coding, the Activity APIs
+    # provide access to notifications, subscriptions, and timelines.
+    namespace :activity
+
+    namespace :emojis
+
+    namespace :gists
+
+    namespace :gitignore
+    alias :git_ignore :gitignore
+
+    # The Git Database API gives you access to read and write raw Git objects
+    # to your Git database on GitHub and to list and update your references
+    # (branch heads and tags).
+    namespace :git_data
+    alias :git :git_data
+
+    namespace :issues
+
+    namespace :markdown
+
+    namespace :meta
+
+    # An API for users to manage their own tokens. You can only access your own
+    # tokens, and only through Basic Authentication.
+    namespace :authorizations
+    alias :oauth :authorizations
+    alias :auth :authorizations
+
+    namespace :orgs
+    alias :organizations :orgs
+
+    namespace :projects
+
+    namespace :pull_requests
+    alias :pulls :pull_requests
+
+    namespace :repos
+    alias :repositories :repos
+
+    namespace :say
+    alias :octocat :say
+
+    namespace :scopes
+
+    namespace :search
+
+    # Many of the resources on the users API provide a shortcut for getting
+    # information about the currently authenticated user.
+    namespace :users
+  end # Client
+end # Github

data/lib/github_api/client/activity.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+require_relative '../api'
+
+module Github
+  class Client::Activity < API
+
+    require_all 'github_api/client/activity',
+      'events',
+      'notifications',
+      'feeds',
+      'starring',
+      'watching'
+
+    # Access to Activity::Events API
+    namespace :events
+
+    # Access to Activity::Notifications API
+    namespace :notifications
+
+    # Access to Activity::Feeds API
+    namespace :feeds
+
+    # Access to Activity::Starring API
+    namespace :starring
+
+    # Access to Activity::Watching API
+    namespace :watching
+
+  end # Activity
+end # Github

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

@@ -0,0 +1,233 @@
+# encoding: utf-8
+
+require_relative '../../api'
+
+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
+    #  github.activity.events.public { |event| ... }
+    #
+    # @api public
+    def public(*args)
+      arguments(args)
+
+      response = get_request("/events", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :public_events, :public
+    alias_method :list_public, :public
+    alias_method :list_public_events, :public
+
+    # List all repository events for a given user
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.events.repository 'user-name', 'repo-name'
+    #   github.activity.events.repository 'user-name', 'repo-name' { |event| ... }
+    #
+    # @example
+    #   github.activity.events.repository user: 'user-name', repo: 'repo-name'
+    #   github.activity.events.repository user: 'user-name', repo: 'repo-name' {|event| ... }
+    #
+    # @api public
+    def repository(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/events", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    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
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.events.issue 'user-name', 'repo-name'
+    #   github.activity.events.issue 'user-name', 'repo-name' { |event| ... }
+    #
+    # @example
+    #   github.activity.events.issue user: 'user-name', repo: 'repo-name'
+    #   github.activity.events.issue user: 'user-name', repo: 'repo-name' { |event| ... }
+    #
+    # @api public
+    def issue(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/repos/#{arguments.user}/#{arguments.repo}/issues/events", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    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'
+    #   github.activity.events.network 'user-name', 'repo-name' { |event| ... }
+    #
+    # @example
+    #   github.activity.events.network user: 'user-name', repo: 'repo-name'
+    #   github.activity.events.network user: 'user-name', repo: 'repo-name' { |event| ... }
+    #
+    # @api public
+    def network(*args)
+      arguments(args, required: [:user, :repo])
+
+      response = get_request("/networks/#{arguments.user}/#{arguments.repo}/events", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    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'
+    #   github.activity.events.org 'org-name' { |event| ... }
+    #
+    # @example
+    #   github.activity.events.org name: 'org-name'
+    #   github.activity.events.org name: 'org-name' { |event| ... }
+    #
+    # @api public
+    def org(*args)
+      arguments(args, required: [:name])
+
+      response = get_request("/orgs/#{arguments.name}/events", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    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.
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.events.received 'user-name'
+    #   github.activity.events.received 'user-name' { |event| ... }
+    #
+    # 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
+    #   github.activity.events.received 'user-name', public: true { |event| ... }
+    #
+    # @api public
+    def received(*args)
+      arguments(args, required: [:user])
+      params = arguments.params
+
+      public_events = if params['public']
+        params.delete('public')
+        '/public'
+      end
+
+      response = get_request("/users/#{arguments.user}/received_events#{public_events}", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    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.
+    #
+    # @example
+    #   github = Github.new
+    #   github.activity.events.performed 'user-name'
+    #   github.activity.events.performed 'user-name' { |event| ... }
+    #
+    # 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
+    #   github.activity.events.performed 'user-name', public: true { |event| ... }
+    #
+    # @api public
+    def performed(*args)
+      arguments(args, required: [:user])
+      params = arguments.params
+
+      public_events = if params['public']
+        params.delete('public')
+        '/public'
+      end
+
+      response = get_request("/users/#{arguments.user}/events#{public_events}", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias_method :user_performed,      :performed
+    alias_method :list_user_performed, :performed
+
+    # List all events for an organization
+    #
+    # @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
+    #   github = Github.new
+    #   github.activity.events.user_org 'user-name', 'org-name'
+    #   github.activity.events.user_org 'user-name', 'org-name' { |event| ... }
+    #
+    # @example
+    #   github.activity.events.user_org user: 'user-name', name: 'org-name'
+    #   github.activity.events.user_org user: 'user-name', name: 'org-name' {|event| ...}
+    #
+    # @api public
+    def user_org(*args)
+      arguments(args, required: [:user, :name])
+
+      response = get_request("/users/#{arguments.user}/events/orgs/#{arguments.name}", arguments.params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    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