github_api 0.4.9 → 0.4.10

data/README.md

@@ -162,7 +162,8 @@ end
 
 In order to authenticate the user through OAuth2 on GitHub you need to
 
-* visit https://github.com/account/applications/ and register your app
+* visit https://github.com/settings/applications/new and register your app
+  You will need to be logged in to initially register the application.
 
 * authorize your credentials https://github.com/login/oauth/authorize
   You can use convenience methods to help you achieve this that come with this gem:
@@ -205,7 +206,8 @@ In order to pass a mime type with your request do
 ## Configuration
 
 Certain methods require authentication. To get your GitHub OAuth v2 credentials,
-register an app at https://github.com/account/applications/
+register an app at https://github.com/settings/applications/
+You will need to be logged in to register the application.
 
 ```ruby
 Github.configure do |config|

data/lib/github_api.rb

@@ -6,6 +6,7 @@ require 'github_api/constants'
 require 'github_api/utils/url'
 require 'github_api/connection'
 require 'github_api/deprecation'
+require 'github_api/core_ext/ordered_hash'
 
 module Github
   extend Configuration

data/lib/github_api/core_ext/ordered_hash.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+
+module Github
+  module CoreExt #:nodoc:
+
+    if RUBY_VERSION >= '1.9'
+      class OrderedHash < ::Hash; end
+    else
+      class OrderedHash < ::Hash
+        attr_accessor :order
+
+        class << self
+          def [](*args)
+            hsh = OrderedHash.new
+            if Hash == args[0]
+              hsh.replace args[0]
+            elsif (args.size % 2) != 0
+              pp args
+              raise ArgumentError, "odd number of elements for Hash"
+            else
+              0.step(args.size - 1, 2) do |a|
+                b = a + 1
+                hsh[args[a]] = args[b]
+              end
+            end
+            hsh
+          end
+        end
+
+        def initialize(*args, &block)
+          super
+          @order = []
+        end
+
+        def []=(key, value)
+          @order.push key unless member?(key)
+          super key, value
+        end
+
+        def ==(hsh2)
+          return false if @order != hsh2.order
+          super hsh2
+        end
+
+        def clear
+          @order = []
+          super
+        end
+
+        def delete(key)
+          @order.delete key
+          super
+        end
+
+        def each_key
+          @order.each { |k| yield k }
+          self
+        end
+
+        def each_value
+          @order.each { |k| yield self[k] }
+          self
+        end
+
+        def each
+          @order.each { |k| yield k, self[k] }
+          self
+        end
+        alias :each_pair :each
+
+        def delete_if
+          @order.clone.each { |k| delete k if yield }
+          self
+        end
+
+        def values
+          ary = []
+          @order.each { |k| ary.push self[k] }
+          ary
+        end
+
+        def keys
+          @order
+        end
+
+        def replace(hsh2)
+          @order = hsh2.keys
+          super hsh2
+        end
+
+        def shift
+          key = @order.first
+          key ? [key, delete(key)] : super
+        end
+
+        def class
+          Hash
+        end
+
+        def __class__
+          OrderedHash
+        end
+      end # OrderedHash
+    end
+
+  end # CoreExt
+end # Github

data/lib/github_api/repos.rb

@@ -26,7 +26,7 @@ module Github
 
     DEFAULT_REPO_OPTIONS = {
       "homepage"   => "https://github.com",
-      "public"     => true,
+      "private"    => false,
       "has_issues" => true,
       "has_wiki"   => true,
       "has_downloads" => true
@@ -36,7 +36,7 @@ module Github
       name
       description
       homepage
-      public
+      private
       has_issues
       has_wiki
       has_downloads
@@ -76,7 +76,7 @@ module Github
     #  <tt>:name</tt> - Required string
     #  <tt>:description</tt> - Optional string
     #  <tt>:homepage</tt> - Optional string
-    #  <tt>:public</tt> - Optional boolean - true to create public repo, false to create a private one
+    #  <tt>:private</tt> - Optional boolean - <tt>false</tt> to create public reps, <tt>false</tt> to create a private one
     #  <tt>:has_issues</tt> - Optional boolean - <tt>true</tt> to enable issues for this repository, <tt>false</tt> to disable them
     #  <tt>:has_wiki</tt> - Optional boolean - <tt>true</tt> to enable the wiki for this repository, <tt>false</tt> to disable it. Default is <tt>true</tt>
     #  <tt>:has_downloads</tt> Optional boolean - <tt>true</tt> to enable downloads for this repository
@@ -86,7 +86,7 @@ module Github
     #  @github.repos.create_repo "name" => 'repo-name'
     #    "description": "This is your first repo",
     #    "homepage": "https://github.com",
-    #    "public": true,
+    #    "private": false,
     #    "has_issues": true,
     #    "has_wiki": true,
     #    "has_downloads": true
@@ -148,7 +148,7 @@ module Github
     # * <tt>:name</tt> Required string
     # * <tt>:description</tt>   Optional string
     # * <tt>:homepage</tt>      Optional string
-    # * <tt>:public</tt>        Optional boolean - true to create public repo, false to create a private one
+    #  <tt>:private</tt> - Optional boolean - <tt>false</tt> to create public reps, <tt>false</tt> to create a private one
     # * <tt>:has_issues</tt>    Optional boolean - <tt>true</tt> to enable issues for this repository, <tt>false</tt> to disable them
     # * <tt>:has_wiki</tt>      Optional boolean - <tt>true</tt> to enable the wiki for this repository, <tt>false</tt> to disable it. Default is <tt>true</tt>
     # * <tt>:has_downloads</tt> Optional boolean - <tt>true</tt> to enable downloads for this repository
@@ -156,7 +156,7 @@ module Github
     # = Examples
     #
     #  @github = Github.new
-    #  @github.repos.edit_repo('user-name', 'repo-name', { :name => 'hello-world', :description => 'This is your first repo', :homepage => "https://github.com", :public => true, :has_issues => true })
+    #  @github.repos.edit_repo('user-name', 'repo-name', { :name => 'hello-world', :description => 'This is your first repo', :homepage => "https://github.com", :private => false, :has_issues => true })
     #
     def edit_repo(user_name=nil, repo_name=nil, params={})
       _update_user_repo_params(user_name, repo_name)

data/lib/github_api/repos/downloads.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'github_api/s3_uploader'
+
 module Github
   class Repos
     module Downloads
@@ -13,19 +15,6 @@ module Github
         content_type
       ].freeze
 
-      REQUIRED_S3_PARAMS = %w[
-        path
-        acl
-        name
-        accesskeyid
-        policy
-        signature
-        mime_type
-      ].freeze
-
-      # Status code for successful upload to Amazon S3 service
-      SUCCESS_STATUS = 201
-
       # List downloads for a repository
       #
       # = Examples
@@ -110,45 +99,18 @@ module Github
       # the response object as an argument to upload method.
       #
       # = Parameters
-      # * <tt>resource</tt> - Required Hashie::Mash -resource of the create_download call
-      # * <tt>:size</tt> - Required number - size of file in bytes.
+      # * <tt>resource</tt> - Required resource of the create_download call.
+      # * <tt>:filename</tt> - Required filename, a path to a file location.
       #
       def upload(resource, filename)
         _validate_presence_of resource, filename
-        raise ArgumentError, 'Need to provied resource of Github::Repose::Downloads#create_download call' unless resource.is_a? Hashie::Mash
-
-        REQUIRED_S3_PARAMS.each do |key|
-          raise ArgumentError, "Expected following key: #{key}" unless resource.respond_to?(key)
-        end
-
-        # TODO use ordered hash if Ruby < 1.9
-        hash = ruby_18 {
-          require 'active_support'
-          ActiveSupport::OrderedHash.new } || ruby_19 { Hash.new }
-
-        mapped_params = {
-          'key'                   => resource.path,
-          'acl'                   => resource.acl,
-          'success_action_status' => SUCCESS_STATUS,
-          'Filename'              => resource.name,
-          'AWSAccessKeyId'        => resource.accesskeyid,
-          'Policy'                => resource.policy,
-          'Signature'             => resource.signature,
-          'Content-Type'          => resource.mime_type,
-          'file'                  => prepend_at_for(filename.to_s)
-        }
-
-        post('', mapped_params, { :url => resource.s3_url })
+
+        response = Github::S3Uploader.new(resource, filename).send
+        response.body
       end
       alias :upload_to_s3 :upload
       alias :upload_to_amazon :upload
 
-    private
-
-      def prepend_at_for(file)
-        /^@.*/ =~ file ? '@' + file : file
-      end
-
     end # Downloads
   end # Repos
 end # Github

data/lib/github_api/response/xmlize.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'faraday'
+
+module Github
+  class Response::Xmlize < Response
+    dependency 'nokogiri'
+
+    define_parser do |body|
+      ::Nokogiri::XML body
+    end
+
+    def parse(body)
+      case body
+      when ''
+        nil
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        self.class.parser.call body
+      end
+    end
+  end # Response::Xmlize
+end # Github

data/lib/github_api/s3_uploader.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+require 'github_api/response/xmlize'
+
+module Github
+  class S3Uploader
+
+    REQUIRED_S3_PARAMS = %w[
+      path
+      acl
+      name
+      accesskeyid
+      policy
+      signature
+      mime_type
+    ].freeze
+
+    # Status code for successful upload to Amazon S3 service
+    SUCCESS_STATUS = 201
+
+    attr_accessor :resource, :filename
+
+    def initialize(resource, filename)
+      @resource = resource
+      @filename = filename
+    end
+
+    def send
+      REQUIRED_S3_PARAMS.each do |key|
+        unless resource.respond_to?(key)
+          raise ArgumentError, "Expected following key: #{key}"
+        end
+      end
+
+      mapped_params = Github::CoreExt::OrderedHash[
+        'key', resource.path,
+        'acl', resource.acl,
+        'success_action_status', SUCCESS_STATUS,
+        'Filename', resource.name,
+        'AWSAccessKeyId', resource.accesskeyid,
+        'Policy', resource.policy,
+        'Signature', resource.signature,
+        'Content-Type', resource.mime_type,
+        'file', Faraday::UploadIO.new(filename, 'application/octet-stream')
+      ]
+
+      http = Faraday.new do |builder|
+        builder.request :multipart
+        builder.use Github::Response::Xmlize
+        builder.adapter :net_http
+      end
+
+      http.post resource.s3_url, mapped_params
+    end
+
+  end # S3Uploader
+end # Github

data/lib/github_api/version.rb

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

data/spec/github/repos/downloads_spec.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require 'spec_helper'
+require 'github_api/s3_uploader'
 
 describe Github::Repos::Downloads do
   let(:github) { Github.new }
@@ -11,7 +12,6 @@ describe Github::Repos::Downloads do
 
   it { described_class::VALID_DOWNLOAD_PARAM_NAMES.should_not be_nil }
   it { described_class::REQUIRED_PARAMS.should_not be_nil }
-  it { described_class::REQUIRED_S3_PARAMS.should_not be_nil }
 
   describe "downloads" do
     it { github.repos.should respond_to :downloads }
@@ -212,41 +212,25 @@ describe Github::Repos::Downloads do
   end # create_download
 
   describe 'upload' do
-    let(:inputs) do
-      { :name => 'new_file.jpg',
-        :size => 114034,
-        :description => "Latest release",
-        :content_type => 'text/plain' }
-    end
-    let(:resource) { Hashie::Mash.new ::JSON.parse(fixture('repos/download_s3.json').read) }
-    let(:file)     { 'filename' }
+    let(:resource) { stub(:resource) }
+    let(:filename) { 'filename' }
+    let(:res) { stub(:response, :body => 'success') }
+    let(:uploader) { stub(:uploader, :send => res) }
 
     context 'resource uploaded' do
       before do
-        stub_post('', 'https://github.s3.amazonaws.com/').with(resource).
-          to_return(:body => '', :status => 200, :headers => {})
+        Github::S3Uploader.stub(:new) { uploader }
       end
 
       it "should fail if resource is of incorrect type" do
-        expect { github.repos.upload file, file }.to raise_error(ArgumentError)
+        expect { github.repos.upload resource, nil }.to raise_error(ArgumentError)
       end
 
       it "should upload resource successfully" do
-        github.repos.upload resource, file
-        a_post('', 'https://github.s3.amazonaws.com').with(resource).should have_been_made
-      end
-
-    end
-    context 'failed to upload resource' do
-      before do
-        stub_post('', 'https://github.s3.amazonaws.com/').with(resource).
-          to_return(:body => '', :status => 404, :headers => {})
-      end
-
-      it "should faile to retrieve resource" do
-        expect {
-          github.repos.upload resource, file
-        }.to raise_error(Github::Error::NotFound)
+        res = stub(:response, :body => 'success')
+        uploader = stub(:uploader, :send => res)
+        Github::S3Uploader.should_receive(:new).with(resource, filename) { uploader }
+        github.repos.upload(resource, filename).should == 'success'
       end
     end
   end # upload

data/spec/github/repos_spec.rb

@@ -125,7 +125,7 @@ describe Github::Repos do
   end # contributors
 
   describe "create_repo" do
-    let(:inputs) { {:name => 'web', :description => "This is your first repo", :homepage => "https://github.com", :public => true, :has_issues => true, :has_wiki => true}}
+    let(:inputs) { {:name => 'web', :description => "This is your first repo", :homepage => "https://github.com", :private => false, :has_issues => true, :has_wiki => true}}
 
     context "resource created successfully for the authenticated user" do
       before do
@@ -202,7 +202,7 @@ describe Github::Repos do
       { :name => 'web',
         :description => "This is your first repo",
         :homepage => "https://github.com",
-        :public => true,
+        :private => false,
         :has_issues => true,
         :has_wiki => true }
     end

data/spec/github/s3_uploader_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'github_api/s3_uploader'
+
+describe Github::S3Uploader do
+
+  let(:result) {
+    stub(:resource,
+      'path' => 'downloads/octokit/github/droid',
+      'acl'  => 'public-read',
+      'name' => 'droid',
+      "accesskeyid"=>"1DWESVTPGHQVTX38V182",
+      "policy"=> "GlyYXRp==",
+      "signature" => "fMGgiss1w=",
+      "mime_type"=>"image/jpeg",
+      "file"=> '',
+      "s3_url" => 'https://github.s3.amazonaws.com/'
+      )
+  }
+  let(:filename) { '/Users/octokit/droid.jpg' }
+  let(:mapped_hash)  { {} }
+
+  let(:uploader) { Github::S3Uploader.new result, filename }
+
+  before do
+    stub_post('https://github.s3.amazonaws.com/', '').
+      to_return(:body => '', :status => 201, :headers => {})
+    Faraday::UploadIO.stub(:new) { '' }
+    Github::CoreExt::OrderedHash.stub(:[]) {  mapped_hash }
+  end
+
+  it 'checks for missing parameters' do
+    resource = stub(:resource)
+    uploader = Github::S3Uploader.new resource, filename
+    expect {
+      uploader.send
+    }.to raise_error(ArgumentError)
+  end
+
+  it 'serializes file' do
+    Faraday::UploadIO.should_receive(:new) { '' }
+    uploader.send
+  end
+
+  it 'sends request to amazon aws' do
+    uploader.send
+    a_post('https://github.s3.amazonaws.com/', '').with(mapped_hash).
+      should have_been_made
+  end
+
+end # Github::S3Uploader

metadata

@@ -2,7 +2,7 @@
 name: github_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors: 
 - Piotr Murach
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-09 00:00:00 +01:00
+date: 2012-04-15 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -232,6 +232,7 @@ files:
 - lib/github_api/constants.rb
 - lib/github_api/core_ext/array.rb
 - lib/github_api/core_ext/hash.rb
+- lib/github_api/core_ext/ordered_hash.rb
 - lib/github_api/deprecation.rb
 - lib/github_api/error/bad_request.rb
 - lib/github_api/error/client_error.rb
@@ -288,8 +289,10 @@ files:
 - lib/github_api/response/jsonize.rb
 - lib/github_api/response/mashify.rb
 - lib/github_api/response/raise_error.rb
+- lib/github_api/response/xmlize.rb
 - lib/github_api/response.rb
 - lib/github_api/result.rb
+- lib/github_api/s3_uploader.rb
 - lib/github_api/users/emails.rb
 - lib/github_api/users/followers.rb
 - lib/github_api/users/keys.rb
@@ -412,6 +415,7 @@ files:
 - spec/github/request_spec.rb
 - spec/github/response/helpers_spec.rb
 - spec/github/result_spec.rb
+- spec/github/s3_uploader_spec.rb
 - spec/github/users/emails_spec.rb
 - spec/github/users/followers_spec.rb
 - spec/github/users/keys_spec.rb