github_api 0.11.3 → 0.12.0

data/lib/github_api/activity/starring.rb

@@ -1,94 +0,0 @@
-# encoding: utf-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.
-  class Activity::Starring < API
-
-    # List stargazers
-    #
-    # = Examples
-    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
-    #  github.activity.starring.list
-    #  github.activity.starring.list { |star| ... }
-    #
-    def list(*args)
-      arguments(args, :required => [:user, :repo])
-
-      response = get_request("/repos/#{user}/#{repo}/stargazers", arguments.params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # List repos being starred by a user
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.activity.starring.starred :user => 'user-name'
-    #
-    # List repos being starred by the authenticated user
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.activity.starring.starred
-    #
-    def starred(*args)
-      params = arguments(args).params
-
-      response = if (user_name = params.delete('user'))
-        get_request("/users/#{user_name}/starred", params)
-      else
-        get_request("/user/starred", params)
-      end
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-
-    # Check if you are starring a repository
-    #
-    # Returns <tt>true</tt> if this repo is starred by you,<tt>false</tt> otherwise
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.activity.starring.starring? 'user-name', 'repo-name'
-    #
-    def starring?(*args)
-      arguments(args, :required => [:user, :repo])
-
-      get_request("/user/starred/#{user}/#{repo}", arguments.params)
-      true
-    rescue Github::Error::NotFound
-      false
-    end
-
-    # Star a repository
-    #
-    # You need to be authenticated to star a repository
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.activity.starring.star 'user-name', 'repo-name'
-    #
-    def star(*args)
-      arguments(args, :required => [:user, :repo])
-
-      put_request("/user/starred/#{user}/#{repo}", arguments.params)
-    end
-
-    # Unstar a repository
-    #
-    # You need to be authenticated to unstar a repository.
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.activity.starring.unstar 'user-name', 'repo-name'
-    #
-    def unstar(*args)
-      arguments(args, :required => [:user, :repo])
-
-      delete_request("/user/starred/#{user}/#{repo}", arguments.params)
-    end
-
-  end # Activity::Starring
-end # Github

data/lib/github_api/activity/watching.rb

@@ -1,92 +0,0 @@
-# encoding: utf-8
-
-module Github
-  # Watching a Repository registers the user to receive notificactions on new
-  # discussions, as well as events in the user’s activity feed.
-  class Activity::Watching < API
-
-    # List repo watchers
-    #
-    # = Examples
-    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
-    #  github.activity.watching.list
-    #  github.activity.watching.list { |watcher| ... }
-    #
-    def list(*args)
-      arguments(args, :required => [:user, :repo])
-
-      response = get_request("/repos/#{user}/#{repo}/subscribers", arguments.params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # List repos being watched by a user
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.activity.watching.watched :user => 'user-name'
-    #
-    # List repos being watched by the authenticated user
-    #
-    # = Examples
-    #  github = Github.new :oauth_token => '...'
-    #  github.activity.watching.watched
-    #
-    def watched(*args)
-      params = arguments(args).params
-
-      response = if (user_name = params.delete('user'))
-        get_request("/users/#{user_name}/subscriptions", params)
-      else
-        get_request("/user/subscriptions", params)
-      end
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-
-    # Check if you are watching a repository
-    #
-    # Returns <tt>true</tt> if this repo is watched by you, <tt>false</tt> otherwise
-    # = Examples
-    #  github = Github.new
-    #  github.activity.watching.watching? 'user-name', 'repo-name'
-    #
-    def watching?(*args)
-      arguments(args, :required => [:user, :repo])
-
-      get_request("/user/subscriptions/#{user}/#{repo}", arguments.params)
-      true
-    rescue Github::Error::NotFound
-      false
-    end
-
-    # Watch a repository
-    #
-    # You need to be authenticated to watch a repository
-    #
-    # = Examples
-    #  github = Github.new
-    #  github.activity.watching.watch 'user-name', 'repo-name'
-    #
-    def watch(*args)
-      arguments(args, :required => [:user, :repo])
-
-      put_request("/user/subscriptions/#{user}/#{repo}", arguments.params)
-    end
-
-    # Stop watching a repository
-    #
-    # You need to be authenticated to stop watching a repository.
-    # = Examples
-    #  github = Github.new
-    #  github.activity.watching.unwatch 'user-name', 'repo-name'
-    #
-    def unwatch(*args)
-      arguments(args, :required => [:user, :repo])
-
-      delete_request("/user/subscriptions/#{user}/#{repo}", arguments.params)
-    end
-
-  end # Activity::Watching
-end # Github

data/lib/github_api/api_factory.rb

@@ -1,31 +0,0 @@
-# encoding: utf-8
-
-require 'github_api/core_ext/hash'
-
-module Github
-  class ApiFactory
-
-    # 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 # ApiFactory
-end # Github

data/lib/github_api/arguments.rb

@@ -1,166 +0,0 @@
-# encoding: utf-8
-
-module Github
-  # Request arguments handler
-  class Arguments
-
-    include Normalizer
-    include ParameterFilter
-    include Validations
-
-    AUTO_PAGINATION = 'auto_pagination'.freeze
-
-    # Parameters passed to request
-    attr_reader :params
-
-    attr_reader :remaining
-
-    # The request api
-    #
-    attr_reader :api
-
-    # Required arguments
-    #
-    attr_reader :required
-    private :required
-
-    # Optional arguments
-    #
-    attr_reader :optional
-    private :optional
-
-    # Takes api, filters and required arguments
-    #
-    # = Parameters
-    #  :required - arguments that must be present before request is fired
-    #
-    def initialize(api, options={})
-      normalize! options
-      @api      = api
-      @required = options.fetch('required', []).map(&:to_s)
-      @optional = options.fetch('optional', []).map(&:to_s)
-    end
-
-    # Parse arguments to allow for flexible api calls.
-    # Arguments can be part of parameters hash or be simple string arguments.
-    #
-    def parse(*args, &block)
-      options = ParamsHash.new(args.extract_options!)
-      normalize! options
-
-      if !args.size.zero?
-        parse_arguments *args
-      else
-        # Arguments are inside the parameters hash
-        parse_options options
-      end
-      @params = options
-      @remaining = extract_remaining(args)
-      extract_pagination(options)
-      yield_or_eval(&block)
-      self
-    end
-
-    # Remove unkown keys from parameters hash.
-    #
-    # = Parameters
-    #  :recursive - boolean that toggles whether nested filtering should be applied
-    #
-    def sift(keys, key=nil, options={})
-      filter! keys, (key.nil? ? params : params[key]), options if keys.any?
-      self
-    end
-
-    # Check if required keys are present inside parameters hash.
-    #
-    def assert_required(required)
-      assert_required_keys required, params
-      self
-    end
-
-    # Check if parameters match expected values.
-    #
-    def assert_values(values, key=nil)
-      assert_valid_values values, (key.nil? ? params : params[key])
-      self
-    end
-
-    private
-
-    # Check and set all requried arguments.
-    #
-    def parse_arguments(*args)
-      assert_presence_of *args
-      required.each_with_index do |req, indx|
-        api.set req, args[indx]
-      end
-      check_requirement!(*args)
-    end
-
-    # Find remaining arguments
-    #
-    def extract_remaining(args)
-      args[required.size..-1]
-    end
-
-    # Fine auto_pagination parameter in options hash
-    #
-    def extract_pagination(options)
-      if (value = options.delete(AUTO_PAGINATION))
-        api.auto_pagination = value
-      end
-    end
-
-    # Remove required arguments from parameters and
-    # validate their presence(if not nil or empty string).
-    #
-    def parse_options(options)
-      options.each { |key, val| remove_required(options, key, val) }
-      provided_args = check_assignment!(options)
-      check_requirement!(*provided_args.keys)
-    end
-
-    # Remove required argument from parameters
-    #
-    def remove_required(options, key, val)
-      key = key.to_s
-      if required.include? key
-        assert_presence_of val
-        options.delete key
-        api.set key, val
-      end
-    end
-
-    # Check if required arguments have been set on instance.
-    #
-    def check_assignment!(options)
-      result = required.inject({}) { |hash, arg|
-        if api.respond_to?(:"#{arg}") && (value = api.send(:"#{arg}"))
-          hash[arg] = value
-        end
-        hash
-      }
-      assert_presence_of result
-      result
-    end
-
-    # Check if required arguments are present.
-    #
-    def check_requirement!(*args)
-      args_length     = args.length
-      required_length = required.length
-
-      if args_length < required_length
-        ::Kernel.raise ArgumentError, "wrong number of arguments (#{args_length} for #{required_length})"
-      end
-    end
-
-    # Evaluate block
-    #
-    def yield_or_eval(&block)
-      return unless block
-      block.arity > 0 ? yield(self) : self.instance_eval(&block)
-    end
-
-  end # Arguments
-end # Github

data/lib/github_api/authorizations.rb

@@ -1,140 +0,0 @@
-# encoding: utf-8
-
-module Github
-
-  # OAuth Authorizations API
-  class Authorizations < API
-
-    Github::require_all 'github_api/authorizations', 'app'
-
-    VALID_AUTH_PARAM_NAMES = %w[
-      scopes
-      add_scopes
-      remove_scopes
-      note
-      note_url
-      client_id
-      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
-    #
-    # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.list
-    #  github.oauth.list { |auth| ... }
-    #
-    # @api public
-    def list(*args)
-      raise_authentication_error unless authenticated?
-      arguments(args)
-
-      response = get_request('/authorizations', arguments.params)
-      return response unless block_given?
-      response.each { |el| yield el }
-    end
-    alias :all :list
-
-    # Get a single authorization
-    #
-    # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.get 'authorization-id'
-    #
-    # @return [ResponseWrapper]
-    #
-    # @api public
-    def get(*args)
-      raise_authentication_error unless authenticated?
-      arguments(args, required: [:authorization_id])
-
-      get_request("/authorizations/#{authorization_id}", arguments.params)
-    end
-    alias :find :get
-
-    # Create a new authorization
-    #
-    # @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.
-    #
-    # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.create
-    #    "scopes" => ["public_repo"]
-    #
-    # @api public
-    def create(*args)
-      raise_authentication_error unless authenticated?
-      arguments(args) do
-        sift VALID_AUTH_PARAM_NAMES
-      end
-
-      post_request('/authorizations', arguments.params)
-    end
-
-    # Update an existing authorization
-    #
-    # @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.
-    #
-    # @example
-    #  github = Github.new basic_auth: 'login:password'
-    #  github.oauth.update "authorization-id", add_scopes: ["repo"]
-    #
-    # @api public
-    def update(*args)
-      raise_authentication_error unless authenticated?
-      arguments(args, required: [:authorization_id]) do
-        sift VALID_AUTH_PARAM_NAMES
-      end
-
-      patch_request("/authorizations/#{authorization_id}", arguments.params)
-    end
-    alias :edit :update
-
-    # Delete an authorization
-    #
-    # @example
-    #  github.oauth.delete 'authorization-id'
-    #
-    # @api public
-    def delete(*args)
-      raise_authentication_error unless authenticated?
-      arguments(args, required: [:authorization_id])
-
-      delete_request("/authorizations/#{authorization_id}", arguments.params)
-    end
-    alias :remove :delete
-
-    protected
-
-    def raise_authentication_error
-      raise ArgumentError, 'You can only access your own tokens' +
-        ' via Basic Authentication'
-    end
-
-  end # Authorizations
-end # Github