github_api 0.5.1 → 0.5.2

data/features/support/settings.rb

@@ -4,4 +4,4 @@ def settings_file
   Pathname.new(File.expand_path("../../settings.yml", __FILE__))
 end
 
-SETTINGS = (File.exists?(settings_file) && yaml= YAML.load_file(settings_file)) ? yaml : {'basic_auth' => 'login:password', 'oauth_token' => 'as79asfd79ads', 'user'=> 'octokat', 'repo' => 'dummy'}
+SETTINGS = (File.exists?(settings_file) && yaml= YAML.load_file(settings_file)) ? yaml : {'basic_auth' => 'login:password', 'oauth_token' => 'as79asfd79ads', 'user'=> 'octokat', 'repo' => 'dummy', 'email' => 'email@example.com'}

data/features/support/vcr.rb

@@ -4,6 +4,7 @@ VCR.configure do |conf|
   conf.hook_into :webmock
   conf.cassette_library_dir = 'features/cassettes'
   conf.default_cassette_options = { :record => :new_episodes }
+  conf.filter_sensitive_data('<EMAIL>') { SETTINGS['email'] }
   conf.filter_sensitive_data('<TOKEN>') { SETTINGS['oauth_token'] }
   conf.filter_sensitive_data('<BASIC_AUTH>') { SETTINGS['basic_auth'] }
   conf.filter_sensitive_data('<USER>') { SETTINGS['user'] }

data/features/users/emails.feature

@@ -0,0 +1,37 @@
+Feature: Accessing Users Emails API
+
+  In order to interact with github user emails
+  GithubAPI gem
+  Should return the expected results depending on passed parameters
+
+  Background:
+    Given I have "Github::Users::Emails" instance
+
+  Scenario: Lists all emails for the authenticated user
+    Given I want to list resources
+    When I make request within a cassette named "users/emails/all"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Add email addresses for the authenticated user
+    Given I want to add resource with the following params:
+      | email1              | email2            |
+      | octocat@example.com | terry@example.com |
+    When I make request within a cassette named "users/emails/add"
+    Then the response status should be 201
+      And the response type should be JSON
+      And the response should have 3 items
+      And the response should contain octocat@example.com
+      And the response should contain terry@example.com
+
+  Scenario: Remove email addresses for the authenticated user
+    Given I want to add resource with the following params:
+      | email1              | email2            |
+      | octocat@example.com | terry@example.com |
+    And I make request within a cassette named "users/emails/add"
+    And I want to delete resource with the following params:
+      | email               |
+      | octocat@example.com |
+    When I make request within a cassette named "users/emails/delete"
+    Then the response status should be 204

data/lib/github_api/connection.rb

@@ -8,6 +8,7 @@ require 'github_api/response/helpers'
 require 'github_api/response/raise_error'
 require 'github_api/request/oauth2'
 require 'github_api/request/basic_auth'
+require 'github_api/request/jsonize'
 
 module Github
   module Connection
@@ -51,7 +52,7 @@ module Github
         Faraday.new(merged_options.merge(connection_options)) do |builder|
           puts options.inspect if ENV['DEBUG']
 
-          builder.use Faraday::Request::JSON
+          builder.use Github::Request::Jsonize
           builder.use Faraday::Request::Multipart
           builder.use Faraday::Request::UrlEncoded
           builder.use Faraday::Response::Logger if ENV['DEBUG']

data/lib/github_api/gists.rb

@@ -29,8 +29,8 @@ module Github
     # List a user's gists.
     #
     # = Examples
-    #  github = Github.new :user => 'user-name'
-    #  github.gists.list
+    #  github = Github.new
+    #  github.gists.list user: 'user-name'
     #
     # List the authenticated user’s gists or if called anonymously,
     # this will returns all public gists
@@ -39,11 +39,10 @@ module Github
     #  github = Github.new :oauth_token => '...'
     #  github.gists.list
     #
-    def list(user_name=nil, params={})
-      _update_user_repo_params(user_name)
-      process_params do
-        normalize params
-      end
+    def list(params={})
+      _normalize_params_keys(params)
+
+      user = params.delete('user')
 
       response = if user
         get_request("/users/#{user}/gists", params)

data/lib/github_api/issues.rb

@@ -31,7 +31,7 @@ module Github
       'state'     => %w[ open closed ],
       'sort'      => %w[ created updated comments ],
       'direction' => %w[ desc asc ],
-      'since'     => %r{\d{4}-\d{2}-\d{5}:\d{2}:\d{3}}
+      'since'     => %r{\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z}
     }
 
     # Creates new Issues API
@@ -75,7 +75,7 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.issues.list :since => '2011-04-12312:12:121',
+    #  github.issues.list :since => '2011-04-12T12:12:12Z',
     #    :filter => 'created',
     #    :state  => 'open',
     #    :labels => "bug,ui,bla",
@@ -124,6 +124,7 @@ module Github
     #    :sort   => 'comments',
     #    :direction => 'asc'
     #
+    # TODO: remove default nils from params
     def list_repo(user_name=nil, repo_name=nil, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
@@ -143,9 +144,9 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.issues.find 'user-name', 'repo-name', 'issue-id'
+    #  github.issues.get 'user-name', 'repo-name', 'issue-id'
     #
-    def find(user_name, repo_name, issue_id, params={})
+    def get(user_name, repo_name, issue_id, params={})
       _update_user_repo_params(user_name, repo_name)
       _validate_user_repo_params(user, repo) unless user? && repo?
       _validate_presence_of issue_id
@@ -155,6 +156,7 @@ module Github
 
       get_request("/repos/#{user}/#{repo}/issues/#{issue_id}", params)
     end
+    alias :find :get
 
     # Create an issue
     #

data/lib/github_api/request.rb

@@ -42,10 +42,11 @@ module Github
       response = connection(options).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)
         when *METHODS_WITH_BODIES
           request.path = path
-          request.body = MultiJson.dump(_process_params(params)) unless params.empty?
+          request.body = _process_params(params) unless params.empty?
         end
       end
       response.body
@@ -54,7 +55,7 @@ module Github
     private
 
     def _process_params(params) # :nodoc:
-      return params['data'] if params.has_key?('data') && !params['data'].nil?
+      return params['data'] if params.has_key?('data') and !params['data'].nil?
       return params
     end
 

data/lib/github_api/request/jsonize.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Request::Jsonize < Faraday::Middleware
+
+    CONTENT_TYPE = 'Content-Type'.freeze
+    MIME_TYPE    = 'application/json'.freeze
+
+    dependency 'multi_json'
+
+    def call(env)
+      if request_with_body?(env)
+        env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+        env[:body] = encode_body env unless env[:body].respond_to?(:to_str)
+      end
+      @app.call env
+    end
+
+    def encode_body(env)
+      if MultiJson.respond_to?(:dump)
+        MultiJson.dump env[:body]
+      else
+        MultiJson.encode env[:body]
+      end
+    end
+
+    def request_with_body?(env)
+      type = request_type(env)
+      has_body?(env) and (type.empty? or type == MIME_TYPE)
+    end
+
+    # Don't encode bodies in string form
+    def has_body?(env)
+      body = env[:body] and !(body.respond_to?(:to_str) and body.empty?)
+    end
+
+    def request_type(env)
+      type = env[:request_headers][CONTENT_TYPE].to_s
+      type = type.split(';', 2).first if type.index(';')
+      type
+    end
+
+  end # Request::Jsonize
+end # Github

data/lib/github_api/request/oauth2.rb

@@ -5,29 +5,38 @@ require 'faraday'
 module Github
   module Request
     class OAuth2 < Faraday::Middleware
+      include Github::Utils::Url
+
+      ACCESS_TOKEN = 'access_token'.freeze
+      AUTH_HEADER  = 'Authorization'.freeze
+
       dependency 'oauth2'
 
       def call(env)
-#         puts "ENV: #{env.inspect}"
-#         puts "TOKEN : #{@token}"
-#         puts "APP: #{@app}"
-
         # Extract parameters from the query
-        params = env[:url].query_values || {}
-
-        env[:url].query_values = { 'access_token' => @token }.merge(params)
+        params = { ACCESS_TOKEN => @token }.update query_params(env[:url])
 
-        token = env[:url].query_values['access_token']
-
-        env[:request_headers].merge!('Authorization' => "Token token=\"#{token}\"")
+        if token = params[ACCESS_TOKEN] and !token.empty?
+          env[:url].query = build_query params
+          env[:request_headers].merge!(AUTH_HEADER => "Token token=\"#{token}\"")
+        end
 
         @app.call env
       end
 
       def initialize(app, *args)
+        super app
         @app = app
         @token = args.shift
       end
+
+      def query_params(url)
+        if url.query.nil? or url.query.empty?
+          {}
+        else
+          parse_query url.query
+        end
+      end
     end # OAuth2
   end # Request
 end # Github

data/lib/github_api/resource.rb

@@ -0,0 +1,6 @@
+
+module Github
+  class Resource
+
+  end
+end

data/lib/github_api/users/emails.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+require 'cgi'
 
 module Github
   class Users::Emails < API
@@ -30,7 +31,7 @@ module Github
     def add(*args)
       params = _extract_parameters(args)
       _normalize_params_keys(params)
-      params['data'] = [args].flatten if args
+      params['data'] = args if args
       post_request("/user/emails", params)
     end
     alias :<< :add
@@ -47,7 +48,7 @@ module Github
     def delete(*args)
       params = _extract_parameters(args)
       _normalize_params_keys(params)
-      params['data'] = [args].flatten
+      params['data'] = args if args
       delete_request("/user/emails", params)
     end
 

data/lib/github_api/utils/url.rb

@@ -13,6 +13,16 @@ module Github
 
       def unescape(s) CGI.unescape s.to_s end
 
+      def build_query(params)
+        params.map { |k, v|
+          if v.class == Array
+            build_query(v.map { |x| [k, x] })
+          else
+            v.nil? ? escape(k) : "#{escape(k)}=#{escape(v)}"
+          end
+        }.join("&")
+      end
+
       def parse_query(query_string)
         return '' if query_string.nil? || query_string.empty?
         params = {}

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 5
-    PATCH = 1
+    PATCH = 2
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/github/gists_spec.rb

@@ -21,23 +21,23 @@ describe Github::Gists do
         end
 
         it "should get the resources" do
-          github.gists.list user
+          github.gists.list :user => user
           a_get("/users/#{user}/gists").should have_been_made
         end
 
         it "should return array of resources" do
-          gists = github.gists.list user
+          gists = github.gists.list :user => user
           gists.should be_an Array
           gists.should have(1).items
         end
 
         it "should be a mash type" do
-          gists = github.gists.list user
+          gists = github.gists.list :user => user
           gists.first.should be_a Hashie::Mash
         end
 
         it "should get gist information" do
-          gists = github.gists.list user
+          gists = github.gists.list :user => user
           gists.first.user.login.should == 'octocat'
         end
 
@@ -55,7 +55,7 @@ describe Github::Gists do
 
         it "should return 404 with a message 'Not Found'" do
           expect {
-            github.gists.list user
+            github.gists.list :user => user
           }.to raise_error(Github::Error::NotFound)
         end
       end

data/spec/github/issues_spec.rb

@@ -122,7 +122,8 @@ describe Github::Issues do
     end
   end # list_repo
 
-  describe "#find" do
+  describe "#get" do
+    it { github.issues.should respond_to :find }
 
     context "resource found" do
       before do
@@ -133,22 +134,22 @@ describe Github::Issues do
       end
 
       it "should fail to get resource without issue id" do
-        expect { github.issues.find(user, repo, nil)}.to raise_error(ArgumentError)
+        expect { github.issues.get(user, repo, nil)}.to raise_error(ArgumentError)
       end
 
       it "should get the resource" do
-        github.issues.find user, repo, issue_id
+        github.issues.get user, repo, issue_id
         a_get("/repos/#{user}/#{repo}/issues/#{issue_id}").should have_been_made
       end
 
       it "should get issue information" do
-        issue = github.issues.find user, repo, issue_id
+        issue = github.issues.get user, repo, issue_id
         issue.number.should == issue_id
         issue.title.should == 'Found a bug'
       end
 
       it "should return mash" do
-        issue = github.issues.find user, repo, issue_id
+        issue = github.issues.get user, repo, issue_id
         issue.should be_a Hashie::Mash
       end
     end
@@ -163,7 +164,7 @@ describe Github::Issues do
 
       it "should fail to retrive resource" do
         expect {
-          github.issues.find user, repo, issue_id
+          github.issues.get user, repo, issue_id
         }.to raise_error(Github::Error::NotFound)
       end
     end

data/spec/github/request/jsonize_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Github::Request::Jsonize do
+
+  let(:middleware) { described_class.new(lambda { |env| env }) }
+
+  def process(body, content_type=nil)
+    env = {:body => body, :request_headers => {} }
+    env[:request_headers]['Content-Type'] = content_type if content_type
+    middleware.call(env)
+  end
+
+  def result_body() result[:body] end
+  def result_type() result[:request_headers]['Content-Type'] end
+
+  context 'no body' do
+    let(:result) { process(nil) }
+
+    it "doesn't change body" do
+      result_body.should be_nil
+    end
+
+    it "doesn't add content type" do
+      result_type.should be_nil
+    end
+  end
+
+  context 'empty body' do
+    let(:result) { process('') }
+
+    it "doesn't change body" do
+      result_body.should be_empty
+    end
+
+    it "doesn't add conten type" do
+      result_type.should be_nil
+    end
+  end
+
+  context 'string body' do
+    let(:result) { process('{"a":1}')}
+
+    it "doesn't change body" do
+      result_body.should eql '{"a":1}'
+    end
+
+    it "adds content type" do
+      result_type.should eql 'application/json'
+    end
+  end
+
+  context "object body" do
+    let(:result) { process({:a => 1})}
+
+    it "encodes body" do
+      result_body.should eql '{"a":1}'
+    end
+
+    it "adds content type" do
+      result_type.should eql 'application/json'
+    end
+  end
+
+  context "empty object body" do
+    let(:result) { process({})}
+
+    it "encodes body" do
+      result_body.should eql '{}'
+    end
+
+    it "adds content type" do
+      result_type.should eql 'application/json'
+    end
+  end
+
+  context 'object body with json type' do
+    let(:result) { process({:a => 1}, 'application/json; charset=utf-8')}
+
+    it "encodes body" do
+      result_body.should eql '{"a":1}'
+    end
+
+    it "doesn't change content type" do
+      result_type.should eql 'application/json; charset=utf-8'
+    end
+  end
+
+end # Github::Request::Jsonize