github_api 0.9.7 → 0.10.0

data/lib/github_api/paged_request.rb

@@ -33,7 +33,7 @@ module Github
         params[PARAM_PAGE] = default_page
       end
 
-      current_api.get_request(path, params)
+      current_api.get_request(path, ParamsHash.new(params))
     end
 
   end # PagedRequest

data/lib/github_api/parameter_filter.rb

@@ -10,7 +10,7 @@ module Github
     #
     def filter!(keys, params, options={:recursive => true})  # :nodoc:
       case params
-      when Hash
+      when Hash, ParamsHash
         params.keys.each do |k, v|
           unless (keys.include?(k) or Github::Validations::VALID_API_KEYS.include?(k))
             params.delete(k)

data/lib/github_api/params_hash.rb

@@ -1,30 +1,67 @@
+# encoding: utf-8
+
 module Github
-  class ParamsHash < ::Hash
-
-    def initialize(*args, &block)
-      hash = args.extract_options!
-      # debugger
-      # debugger
-      # normalize_keys!(hash)
-      # debugger
-      super[hash]
+
+  # Class responsible for holding request parameters
+  class ParamsHash < DelegateClass(Hash)
+    include Normalizer
+    include MimeType
+
+    def initialize(hash)
+      super(normalize!(Hash[hash]))
     end
 
-    def normalize_keys!(params)
-      case params
-      when Hash
-        params.keys.each do |k|
-          params[k.to_s] = params.delete(k)
-          normalize_keys!(params[k.to_s])
-        end
-      when Array
-        params.map! do |el|
-          normalize_keys!(el)
-        end
+    # Extract and parse media type param
+    #
+    #  [.version].param[+json]
+    #
+    def media
+      parse(self.delete('media'))
+    end
+
+    # Return accept header if present
+    #
+    def accept
+      if has_key?('accept')
+        self.delete('accept')
+      elsif has_key?('media')
+        media
+      else
+        nil
+      end
+    end
+
+    # Extract request data from paramters
+    #
+    def data
+      if has_key?('data') && !self['data'].nil?
+        return self.delete('data')
       else
-        params.to_s
+        return self.to_hash
+      end
+    end
+
+    # Any client configuration options
+    #
+    def options
+      hash = has_key?('options') ? self.delete('options') : {}
+      if value = accept
+        hash[:headers] = {} unless hash.has_key?(:headers)
+        hash[:headers]['Accept'] = value
+      end
+      hash[:raw] = has_key?('raw') ? self.delete('raw') : false
+      hash
+    end
+
+    # Update hash with default parameters for non existing keys
+    #
+    def merge_default(defaults)
+      if defaults && !defaults.empty?
+        defaults.each do |key, value|
+          self[key] = value unless self.has_key?(key)
+        end
       end
-      return params
+      self
     end
 
   end # ParamsHash

data/lib/github_api/repos.rb

@@ -16,6 +16,7 @@ module Github
       :Keys          => 'keys',
       :Merging       => 'merging',
       :PubSubHubbub  => 'pub_sub_hubbub',
+      :Statistics    => 'statistics',
       :Statuses      => 'statuses'
 
     DEFAULT_REPO_OPTIONS = {
@@ -94,6 +95,11 @@ module Github
       @pubsubhubbub ||= ApiFactory.new('Repos::PubSubHubbub', current_options.merge(options), &block)
     end
 
+    # Access to Repos::Statistics API
+    def stats(options={}, &block)
+      @stats ||= ApiFactory.new('Repos::Statistics', current_options.merge(options), &block)
+    end
+
     # Access to Repos::Statuses API
     def statuses(options={}, &block)
       @statuses ||= ApiFactory.new('Repos::Statuses', current_options.merge(options), &block)
@@ -209,9 +215,9 @@ module Github
 
       # Requires authenticated user
       if (org = params.delete("org"))
-        post_request("/orgs/#{org}/repos", DEFAULT_REPO_OPTIONS.merge(params))
+        post_request("/orgs/#{org}/repos", params.merge_default(DEFAULT_REPO_OPTIONS))
       else
-        post_request("/user/repos", DEFAULT_REPO_OPTIONS.merge(params))
+        post_request("/user/repos", params.merge_default(DEFAULT_REPO_OPTIONS))
       end
     end
 
@@ -284,7 +290,7 @@ module Github
       end
       params = arguments.params
 
-      patch_request("/repos/#{user}/#{repo}", DEFAULT_REPO_OPTIONS.merge(params))
+      patch_request("/repos/#{user}/#{repo}", params.merge_default(DEFAULT_REPO_OPTIONS))
     end
 
     # Delete a repository

data/lib/github_api/repos/pub_sub_hubbub.rb

@@ -25,8 +25,9 @@ module Github
     def subscribe(*args)
       params = arguments(args, :required => [:topic, :callback]).params
       _merge_action!("subscribe", topic, callback, params)
+      params['options'] = OPTIONS
 
-      post_request("/hub", params, OPTIONS)
+      post_request("/hub", params)
     end
 
     # Unsubscribe from existing topic/event through pubsubhubbub
@@ -46,8 +47,9 @@ module Github
     def unsubscribe(*args)
       params = arguments(args, :required => [:topic, :callback]).params
       _merge_action!("unsubscribe", topic, callback, params)
+      params['options'] = OPTIONS
 
-      post_request("/hub", params, OPTIONS)
+      post_request("/hub", params)
     end
 
     # Subscribe repository to service hook through pubsubhubbub

data/lib/github_api/repos/statistics.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+
+module Github
+
+  # The Repository Statistics API allows you to fetch the data that GitHub uses
+  # for visualizing different types of repository activity.
+  class Repos::Statistics < API
+
+    # Get contributors list with additions, deletions, and commit counts
+    #
+    # = Examples
+    #
+    #  github = Github.new
+    #  github.repos.stats.contributors user: '...', repo: '...'
+    #  github.repos.stats.contributors user: '...', repo: '...' { |stat| ... }
+    #
+    def contributors(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
+
+      response = get_request("/repos/#{user}/#{repo}/stats/contributors", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Get the last year of commit activity data
+    #
+    # Returns the last year of commit activity grouped by week.
+    # The days array is a group of commits per day, starting on Sunday
+    #
+    # = Examples
+    #
+    #  github = Github.new
+    #  github.repos.stats.commit_activity user: '...', repo: '...'
+    #  github.repos.stats.commit_activity user: '...', repo: '...' { |stat| ... }
+    #
+    def commit_activity(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
+
+      response = get_request("/repos/#{user}/#{repo}/stats/commit_activity", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+    # Get the number of additions and deletions per week
+    #
+    # = Examples
+    #
+    #  github = Github.new
+    #  github.repos.stats.code_frequency user: '...', repo: '...'
+    #  github.repos.stats.code_frequency user: '...', repo: '...' { |stat| ... }
+    #
+    def code_frequency(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
+
+      get_request("/repos/#{user}/#{repo}/stats/code_frequency", params)
+    end
+
+    # Get the weekly commit count for the repo owner and everyone else
+    #
+    # = Examples
+    #
+    #  github = Github.new
+    #  github.repos.stats.participation user: '...', repo: '...'
+    #  github.repos.stats.participation user: '...', repo: '...' { |stat| ... }
+    #
+    def participation(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
+
+      get_request("/repos/#{user}/#{repo}/stats/participation", params)
+    end
+
+    # Get the number of commits per hour in each day
+    #
+    # = Examples
+    #
+    #  github = Github.new
+    #  github.repos.stats.punch_card user: '...', repo: '...'
+    #  github.repos.stats.punch_card user: '...', repo: '...' { |stat| ... }
+    #
+    def punch_card(*args)
+      arguments(args, :required => [:user, :repo])
+      params = arguments.params
+
+      response = get_request("/repos/#{user}/#{repo}/stats/punch_card", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+
+  end # Repos::Statistics
+end # Github

data/lib/github_api/request.rb

@@ -8,34 +8,35 @@ module Github
     METHODS = [:get, :post, :put, :delete, :patch]
     METHODS_WITH_BODIES = [ :post, :put, :patch ]
 
-    def get_request(path, params={}, options={})
-      request(:get, path, params, options).auto_paginate
+    def get_request(path, params={})
+      request(:get, path, params).auto_paginate
     end
 
-    def patch_request(path, params={}, options={})
-      request(:patch, path, params, options)
+    def patch_request(path, params={})
+      request(:patch, path, params)
     end
 
-    def post_request(path, params={}, options={})
-      request(:post, path, params, options)
+    def post_request(path, params={})
+      request(:post, path, params)
     end
 
-    def put_request(path, params={}, options={})
-      request(:put, path, params, options)
+    def put_request(path, params={})
+      request(:put, path, params)
     end
 
-    def delete_request(path, params={}, options={})
-      request(:delete, path, params, options)
+    def delete_request(path, params={})
+      request(:delete, path, params)
     end
 
-    def request(method, path, params, options) # :nodoc:
+    def request(method, path, params) # :nodoc:
       if !METHODS.include?(method)
         raise ArgumentError, "unkown http method: #{method}"
       end
 
-      puts "EXECUTED: #{method} - #{path} with #{params} and #{options}" if ENV['DEBUG']
+      puts "EXECUTED: #{method} - #{path} with PARAMS: #{params}" if ENV['DEBUG']
 
-      conn = connection(options.merge(current_options))
+      conn_options = params.options.merge(current_options)
+      conn = connection(conn_options)
       if conn.path_prefix != '/' && path.index(conn.path_prefix) != 0
         path = (conn.path_prefix + path).gsub(/\/(\/)*/, '/')
       end
@@ -43,27 +44,15 @@ module Github
       response = conn.send(method) do |request|
         case method.to_sym
         when *(METHODS - METHODS_WITH_BODIES)
-          request.body = params.delete('data') if params.has_key?('data')
-          request.url(path, params)
+          request.body = params.data if params.has_key?('data')
+          request.url(path, params.to_hash)
         when *METHODS_WITH_BODIES
           request.path = path
-          request.body = extract_data_from_params(params) unless params.empty?
+          request.body = params.data unless params.empty?
         end
       end
       ResponseWrapper.new(response, self)
     end
 
-    private
-
-    def extract_data_from_params(params) # :nodoc:
-      return params['data'] if params.has_key?('data') and !params['data'].nil?
-      return params
-    end
-
-    def _extract_mime_type(params, options) # :nodoc:
-      options['resource']  = params['resource'] ? params.delete('resource') : ''
-      options['mime_type'] = params['resource'] ? params.delete('mime_type') : ''
-    end
-
   end # Request
 end # Github

data/lib/github_api/response_wrapper.rb

@@ -22,6 +22,14 @@ module Github
       @env         = response.env
     end
 
+    # Overwrite methods to hash keys
+    #
+    ['id', 'type', 'fork'].each do |method_name|
+      define_method(method_name) do
+        self.body.fetch(method_name.to_s)
+      end
+    end
+
     # Request url
     #
     def url

data/lib/github_api/say.rb

@@ -14,8 +14,9 @@ module Github
     def say(*args)
       params = arguments(*args).params
       params[:s] = args.shift unless args.empty?
+      params['raw'] = true
 
-      get_request('/octocat', params, :raw => true)
+      get_request('/octocat', params)
     end
 
   end # Say

data/lib/github_api/scopes.rb

@@ -9,8 +9,9 @@ module Github
     #  github = Github.new :oauth_token => 'token'
     #  github.scopes.all
     #
-    def list(params={})
-      response = get_request("/user", params)
+    def list(*args)
+      arguments(args)
+      response = get_request("/user", arguments.params)
       response.headers.oauth_scopes ? response.headers.oauth_scopes.split(',') : response
     end
     alias :all :list

data/lib/github_api/search.rb

@@ -21,7 +21,7 @@ module Github
       required = ['owner', 'repo', 'state', 'keyword']
       arguments(args, :required => required)
 
-      get_request("/legacy/issues/search/#{owner}/#{repo}/#{state}/#{escape(keyword)}", arguments.params)
+      get_request("/legacy/issues/search/#{owner}/#{repo}/#{state}/#{escape_uri(keyword)}", arguments.params)
     end
 
     # Search repositories
@@ -39,7 +39,7 @@ module Github
     def repos(*args)
       arguments(args, :required => [:keyword])
 
-      get_request("/legacy/repos/search/#{escape(keyword)}", arguments.params)
+      get_request("/legacy/repos/search/#{escape_uri(keyword)}", arguments.params)
     end
     alias :repositories :repos
 
@@ -57,7 +57,7 @@ module Github
     def users(*args)
       arguments(args, :required => [:keyword])
 
-      get_request("/legacy/user/search/#{escape(keyword)}", arguments.params)
+      get_request("/legacy/user/search/#{escape_uri(keyword)}", arguments.params)
     end
 
     # Search email

data/lib/github_api/utils/url.rb

@@ -1,4 +1,5 @@
 require 'cgi'
+require 'addressable/uri'
 
 module Github
   module Utils
@@ -9,9 +10,11 @@ module Github
 
       KEY_VALUE_SEP = '='.freeze
 
-      def escape(s) CGI.escape s.to_s end
+      def escape_uri(s) Addressable::URI.escape(s.to_s) end
 
-      def unescape(s) CGI.unescape s.to_s end
+      def escape(s) CGI.escape(s.to_s) end
+
+      def unescape(s) CGI.unescape(s.to_s) end
 
       def build_query(params)
         params.map { |k, v|

data/lib/github_api/version.rb

@@ -3,8 +3,8 @@
 module Github
   module VERSION
     MAJOR = 0
-    MINOR = 9
-    PATCH = 7
+    MINOR = 10
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/fixtures/repos/commit_activity.json

@@ -0,0 +1,15 @@
+[
+  {
+    "days": [
+      0,
+      3,
+      26,
+      20,
+      39,
+      1,
+      0
+    ],
+    "total": 89,
+    "week": "2012-05-06"
+  }
+]