github_api 0.10.1 → 0.10.2

data/features/support/settings.rb

@@ -4,4 +4,8 @@ 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', 'email' => 'email@example.com'}
+def live_credentials?
+  true
+end
+
+SETTINGS = (live_credentials? && File.exists?(settings_file) && yaml= YAML.load_file(settings_file)) ? yaml : {'basic_auth' => 'login:password', 'oauth_token' => 'as79asfd79ads', 'user'=> 'murek', 'repo' => 'dummy', 'email' => 'email@example.com'}

data/features/support/vcr.rb

@@ -8,6 +8,7 @@ VCR.configure do |conf|
   conf.filter_sensitive_data('<TOKEN>') { SETTINGS['oauth_token'] }
   conf.filter_sensitive_data('<BASIC_AUTH>') { SETTINGS['basic_auth'] }
   conf.filter_sensitive_data('<USER>') { SETTINGS['user'] }
+  conf.debug_logger = File.open('test.log', 'w')
 end
 
 VCR.cucumber_tags do |t|

data/lib/github_api/issues.rb

@@ -126,15 +126,6 @@ module Github
     #    :sort   => 'comments',
     #    :direction => 'asc'
     #
-    #  github = Github.new :user => 'user-name', :repo => 'repo-name'
-    #  github.issues.list_repo :milestone => 1,
-    #    :state  => 'open',
-    #    :assignee => '*',
-    #    :mentioned => 'octocat',
-    #    :labels => "bug,ui,bla",
-    #    :sort   => 'comments',
-    #    :direction => 'asc'
-    #
     def list(*args)
       params = arguments(args) do
         assert_values VALID_ISSUE_PARAM_VALUES
@@ -146,7 +137,7 @@ module Github
       elsif (user_name = params.delete('user')) &&
             (repo_name = params.delete('repo'))
 
-        list_repo user_name, repo_name, params
+        list_repo user_name, repo_name
       elsif args.include? :user
         get_request("/user/issues", params)
       else
@@ -160,12 +151,7 @@ module Github
     # List issues for a repository
     #
     # def list_repo(user_name, repo_name, params)
-    def list_repo(*args)
-      arguments(args, :required => [:user, :repo]) do
-        sift VALID_ISSUE_PARAM_NAMES
-        assert_values VALID_ISSUE_PARAM_VALUES
-      end
-
+    def list_repo(user, repo)
       get_request("/repos/#{user}/#{repo}/issues", arguments.params)
     end
     private :list_repo

data/lib/github_api/jsonable.rb

@@ -7,6 +7,7 @@ module Github
     extend self
 
     def decode(*args)
+      return unless args.first
       if MultiJson.respond_to?(:load)
         MultiJson.load *args
       else

data/lib/github_api/params_hash.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'delegate'
+require 'base64'
 
 module Github
 
@@ -66,5 +67,17 @@ module Github
       self
     end
 
+    # Base64 encode string removing newline characters
+    #
+    def strict_encode64(key)
+      value = self[key]
+      encoded = if Base64.respond_to?(:strict_encode64)
+        Base64.strict_encode64(value)
+      else
+        [value].pack("m0")
+      end
+      self[key] = encoded.delete("\n\r")
+    end
+
   end # ParamsHash
 end # Github

data/lib/github_api/rate_limit.rb

@@ -3,12 +3,16 @@
 module Github
   module RateLimit
 
-    def ratelimit
-      get_request("/rate_limit").rate.limit
+    def ratelimit(*args)
+      arguments(args)
+
+      get_request("/rate_limit", arguments.params).rate.limit
     end
 
-    def ratelimit_remaining
-      get_request("/rate_limit").rate.remaining
+    def ratelimit_remaining(*args)
+      arguments(args)
+
+      get_request("/rate_limit", arguments.params).rate.remaining
     end
 
   end # RateLimit

data/lib/github_api/repos.rb

@@ -120,8 +120,8 @@ module Github
     #
     # = Examples
     #   github = Github.new
-    #   github.repos.list every: true
-    #   github.repos.list every: true { |repo| ... }
+    #   github.repos.list :every
+    #   github.repos.list :every { |repo| ... }
     #
     # List public repositories for the specified user.
     #

data/lib/github_api/repos/contents.rb

@@ -6,6 +6,8 @@ module Github
   # as Base64 encoded content.
   class Repos::Contents < API
 
+    REQUIRED_CONTENT_OPTIONS = %w[ path message content ]
+
     # Get the README
     #
     # This method returns the preferred README for a repository.
@@ -46,6 +48,114 @@ module Github
     end
     alias :find :get
 
+    # Create a file
+    #
+    # This method creates a new file in a repository
+    #
+    # = Parameters
+    # * <tt>:path</tt>    - Requried string - The content path
+    # * <tt>:message</tt> - Requried string - The commit message
+    # * <tt>:content</tt> - Requried string - The new file content,
+    #                       which will be Base64 encoded
+    # * <tt>:branch</tt>  - Optional string - The branch name. If not provided,
+    #                       uses the repository’s default branch (usually master)
+    # = Optional Parameters
+    #
+    # The <tt>author</tt> section is optional and is filled in with the
+    # <tt>committer</tt> information if omitted. If the <tt>committer</tt>
+    # information is omitted, the authenticated user’s information is used.
+    #
+    # You must provide values for both <tt>name</tt> and <tt>email</tt>, whether
+    # you choose to use <tt>author</tt> or <tt>committer</tt>. Otherwise, you’ll
+    # receive a <tt>500</tt> status code.
+    #
+    # * <tt>author.name</tt>  - string - The name of the author of the commit
+    # * <tt>author.email</tt> - string - The email of the author of the commit
+    # * <tt>committer.name</tt> - string - The name of the committer of the commit
+    # * <tt>committer.email</tt> - string - The email of the committer of the commit
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.contents.create 'user-name', 'repo-name', 'path',
+    #    path: 'hello.rb',
+    #    content: "puts 'hello ruby'",
+    #    message: "my commit message"
+    #
+    def create(*args)
+      arguments(args, :required => [:user, :repo, :path]) do
+        assert_required REQUIRED_CONTENT_OPTIONS
+      end
+      params = arguments.params
+      params.strict_encode64('content')
+
+      put_request("/repos/#{user}/#{repo}/contents/#{path}", params)
+    end
+
+    # Update a file
+    #
+    # This method updates a file in a repository
+    #
+    # = Parameters
+    # * <tt>:path</tt>    - Requried string - The content path
+    # * <tt>:message</tt> - Requried string - The commit message
+    # * <tt>:content</tt> - Requried string - The new file content,
+    #                       which will be Base64 encoded
+    # * <tt>:sha</tt>     - Requried string -  The blob SHA of the file being replaced.
+    # * <tt>:branch</tt>  - Optional string - The branch name. If not provided,
+    #                       uses the repository’s default branch (usually master)
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.contents.update 'user-name', 'repo-name', 'path',
+    #    path: 'hello.rb',
+    #    content: "puts 'hello ruby again'",
+    #    message: "my commit message",
+    #    sha: "25b0bef9e404bd2e3233de26b7ef8cbd86d0e913"
+    #
+    def update(*args)
+      create(*args)
+    end
+
+    # Delete a file
+    #
+    # This method deletes a file in a repository
+    #
+    # = Parameters
+    # * <tt>:path</tt>    - Requried string - The content path
+    # * <tt>:message</tt> - Requried string - The commit message
+    # * <tt>:sha</tt>     - Requried string - The blob SHA of the file being removed.
+    # * <tt>:branch</tt>  - Optional string - The branch name. If not provided,
+    #                       uses the repository’s default branch (usually master)
+    # = Optional Parameters
+    #
+    # The <tt>author</tt> section is optional and is filled in with the
+    # <tt>committer</tt> information if omitted. If the <tt>committer</tt>
+    # information is omitted, the authenticated user’s information is used.
+    #
+    # You must provide values for both <tt>name</tt> and <tt>email</tt>, whether
+    # you choose to use <tt>author</tt> or <tt>committer</tt>. Otherwise, you’ll
+    # receive a <tt>500</tt> status code.
+    #
+    # * <tt>author.name</tt>  - string - The name of the author of the commit
+    # * <tt>author.email</tt> - string - The email of the author of the commit
+    # * <tt>committer.name</tt> - string - The name of the committer of the commit
+    # * <tt>committer.email</tt> - string - The email of the committer of the commit
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.repos.contents.delete 'user-name', 'repo-name', 'path',
+    #    path: 'hello.rb',
+    #    message: "delete hello.rb file",
+    #    sha: "329688480d39049927147c162b9d2deaf885005f"
+    #
+    def delete(*args)
+      arguments(args, :required => [:user, :repo, :path]) do
+        assert_required %w[ path message sha ]
+      end
+
+      delete_request("/repos/#{user}/#{repo}/contents/#{path}", arguments.params)
+    end
+
     # Get archive link
     #
     # This method will return a 302 to a URL to download a tarball or zipball

data/lib/github_api/response/raise_error.rb

@@ -7,10 +7,10 @@ module Github
   class Response::RaiseError < Faraday::Response::Middleware
 
     def on_complete(env)
-      status_code = env[:status].to_i
+      status_code   = env[:status].to_i
       service_error = Github::Error::ServiceError
       error_class = service_error.errors[status_code]
-      error_class = service_error if !error_class and (400...600).include? status_code
+      error_class = service_error if !error_class and (400...600) === status_code
       raise error_class.new(env) if error_class
     end
 

data/lib/github_api/version.rb

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

data/spec/fixtures/repos/content_created.json

@@ -0,0 +1,44 @@
+{
+  "content": {
+    "name": "hello.txt",
+    "path": "notes/hello.txt",
+    "sha": "95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+    "size": 9,
+    "url": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+    "html_url": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt",
+    "git_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+    "type": "file",
+    "_links": {
+      "self": "https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt",
+      "git": "https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3",
+      "html": "https://github.com/octocat/Hello-World/blob/master/notes/hello.txt"
+    }
+  },
+  "commit": {
+    "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+    "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
+    "author": {
+      "date": "2010-04-10T14:10:01-07:00",
+      "name": "Scott Chacon",
+      "email": "schacon@gmail.com"
+    },
+    "committer": {
+      "date": "2010-04-10T14:10:01-07:00",
+      "name": "Scott Chacon",
+      "email": "schacon@gmail.com"
+    },
+    "message": "my commit message",
+    "tree": {
+      "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
+      "sha": "691272480426f78a0138979dd3ce63b77f706feb"
+    },
+    "parents": [
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+        "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+        "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
+      }
+    ]
+  }
+}

data/spec/fixtures/repos/content_deleted.json

@@ -0,0 +1,30 @@
+{
+  "content": null,
+  "commit": {
+    "sha": "7638417db6d59f3c431d3e1f261cc637155684cd",
+    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd",
+    "html_url": "https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd",
+    "author": {
+      "date": "2010-04-10T14:10:01-07:00",
+      "name": "Scott Chacon",
+      "email": "schacon@gmail.com"
+    },
+    "committer": {
+      "date": "2010-04-10T14:10:01-07:00",
+      "name": "Scott Chacon",
+      "email": "schacon@gmail.com"
+    },
+    "message": "my commit message",
+    "tree": {
+      "url": "https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb",
+      "sha": "691272480426f78a0138979dd3ce63b77f706feb"
+    },
+    "parents": [
+      {
+        "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+        "html_url": "https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5",
+        "sha": "1acc419d4d6a9ce985db7be48c6349a0475975b5"
+      }
+    ]
+  }
+}

data/spec/github/api_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github::API do

data/spec/github/issues/list_spec.rb

@@ -63,6 +63,11 @@ describe Github::Issues, '#list' do
     let(:repo)   { 'github' }
     let(:request_path) { "/repos/#{user}/#{repo}/issues" }
 
+    before {
+      stub_request(:get, "https://api.github.com/repos/peter-murach/github/issues?param1=foo&param2=bar").
+         to_return(:headers => {:content_type => "application/json; charset=utf-8"})
+    }
+    
     it "should get the resources" do
       subject.list :user => user, :repo => repo
       a_get(request_path).should have_been_made
@@ -82,6 +87,11 @@ describe Github::Issues, '#list' do
       result = subject.list(:user => user, :repo => repo) { |obj| yielded << obj }
       yielded.should == result
     end
+
+    it "should pass parameters" do 
+      subject.list :user => user, :repo => repo, :param1 => "foo", :param2 => "bar"
+      a_get(request_path + "?param1=foo&param2=bar").should have_been_made
+    end
   end
 
   it_should_behave_like 'request failure' do

data/spec/github/mime_type_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 
 describe Github::MimeType do

data/spec/github/normalizer_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 require 'github_api/core_ext/hash'
 

data/spec/github/parameter_filter_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require 'spec_helper'
 require 'github_api/core_ext/hash'
 

data/spec/github/params_hash_spec.rb

@@ -61,4 +61,9 @@ describe Github::ParamsHash do
     end
   end
 
+  context 'strict encode' do
+    let(:hash) { { :content => "puts 'hello ruby'"} }
+
+    it { expect(subject.strict_encode64('content')).to eql('cHV0cyAnaGVsbG8gcnVieSc=')  }
+  end
 end

data/spec/github/repos/contents/create_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Repos::Contents, '#create' do
+  let(:user) { 'peter-murach' }
+  let(:repo) { 'github' }
+  let(:path) { 'hello.rb' }
+  let(:request_path) { "/repos/#{user}/#{repo}/contents/#{path}" }
+
+  before {
+    stub_put(request_path).to_return(:body => body, :status => status,
+        :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  let(:params) {
+    {
+      "path"    => 'hello.rb',
+      "content" => "puts 'hello ruby'",
+      "message" => "initial commit"
+    }
+  }
+  let(:body) { fixture('repos/content_created.json') }
+  let(:status) { 201 }
+
+  it { expect { subject.create }.to raise_error(ArgumentError)}
+
+  it { expect { subject.create user, repo, path }.to raise_error(Github::Error::RequiredParams) }
+
+  it "creates the resource" do
+    subject.create user, repo, path, params
+    a_put(request_path).should have_been_made
+  end
+
+  it "gets repository contents information" do
+    content = subject.create user, repo, path, params
+    content.content.name.should == 'hello.txt'
+  end
+end