ghee 0.9.6 → 0.9.7

data/README.md

@@ -18,6 +18,11 @@ Create an OAuth access token:
     user_name, password, scopes = "rauhryan", "secret", ["user","repo"]
     token = Ghee.create_token(user_name, password, scopes)
 
+Create a client for github enterprise
+    
+    gh = Ghee.access_token("your_token","https://foo.com")
+    gh = Ghee.basic_auth("your_user", "your_pass", "https://foo.com")
+
 ## Gists
 
 ### Usage

data/ghee.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency 'faraday'
-  s.add_runtime_dependency 'faraday_middleware'
-  s.add_runtime_dependency 'multi_json'
-  s.add_runtime_dependency 'yajl-ruby'
+  s.add_dependency 'faraday', '~> 0.8'
+  s.add_dependency 'faraday_middleware', '~> 0.9'
+  s.add_dependency 'hashie', '~> 1.2'
+  s.add_dependency 'multi_json', '~> 1.3'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'json_pure'
   s.add_development_dependency 'rspec', '~>2.9.0'
@@ -29,4 +29,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'ZenTest'
   s.add_development_dependency 'autotest-growl'
+  s.add_development_dependency 'uuidtools'
 end

data/lib/ghee.rb

@@ -24,6 +24,7 @@ require 'ghee/api/watchers'
 require 'ghee/api/emails'
 require 'ghee/api/followers'
 require 'ghee/api/pulls'
+require 'ghee/api/search'
 
 class Ghee
   attr_reader :connection
@@ -40,9 +41,9 @@ class Ghee
   #
   # Access_token - String of the access_token
   #
-  def initialize(options = nil)
+  def initialize(options = nil, &block)
     
-    return @connection = Ghee::Connection.new(options) unless options.nil?
+    return @connection = Ghee::Connection.new(options, &block) unless options.nil?
 
     begin
       token = ENV["GH_TOKEN"] || `git config github.token`
@@ -53,16 +54,20 @@ class Ghee
     end
   end
 
-  def self.basic_auth(user_name, password)
-      Ghee.new :basic_auth  => {:user_name => user_name, :password => password}
+  def self.basic_auth(user_name, password, api_url = nil)
+      options = { :basic_auth  => {:user_name => user_name, :password => password} }
+      options[:api_url] = api_url if api_url
+      Ghee.new options
   end
 
-  def self.access_token(token)
-    Ghee.new :access_token => token
+  def self.access_token(token, api_url = nil)
+    options = {  :access_token => token }
+    options[:api_url] = api_url if api_url
+    Ghee.new  options
   end
 
-  def self.create_token(user_name, password, scopes)
-    auth = Ghee.basic_auth(user_name, password).authorizations.create({
+  def self.create_token(user_name, password, scopes, api_url = nil)
+    auth = Ghee.basic_auth(user_name, password, api_url).authorizations.create({
       :scopes => scopes})
     auth["token"]
   end

data/lib/ghee/api/forks.rb

@@ -14,7 +14,6 @@ class Ghee
         class Proxy < ::Ghee::ResourceProxy
            def create(org=nil)
              params = org ? {:org => org} : {}
-             puts params
              connection.post(path_prefix, params).body
            end
         end

data/lib/ghee/api/issues.rb

@@ -69,6 +69,7 @@ class Ghee
         # enables defining methods on the proxy object
         #
         class Proxy < ::Ghee::ResourceProxy
+          attr_accessor :repo
 
           # Close issue - closed issue by id
           #
@@ -120,10 +121,11 @@ class Ghee
         #
         # Returns json
         #
-        def issues(number=nil, params={})
-          params = number if number.is_a?Hash
+        def issues(number=nil)
           prefix = (!number.is_a?(Hash) and number) ? "#{path_prefix}/issues/#{number}" : "#{path_prefix}/issues"
-          Ghee::API::Repos::Issues::Proxy.new(connection, prefix, params)
+          issue = Ghee::API::Repos::Issues::Proxy.new(connection, prefix, number)
+          issue.repo = self
+          issue
         end
       end
     end

data/lib/ghee/api/repos.rb

@@ -14,6 +14,7 @@ class Ghee
       # enables defining methods on the proxy object
       #
       class Proxy < ::Ghee::ResourceProxy
+        attr_accessor :repo_name
       end
 
       # Get repos
@@ -22,9 +23,12 @@ class Ghee
       #
       # Returns json
       #
-      def repos(login,name)
-        path_prefix = "/repos/#{login}/#{name}"
-        Proxy.new(connection, path_prefix)
+      def repos(login,name = nil)
+        repo = name.nil? ? login : "#{login}/#{name}"
+        path_prefix = "/repos/#{repo}"
+        proxy = Proxy.new(connection, path_prefix)
+        proxy.repo_name = repo
+        proxy
       end
 
     end

data/lib/ghee/api/search.rb

@@ -0,0 +1,40 @@
+
+class Ghee
+
+  # API module encapsulates all of API endpoints
+  # implemented thus far
+  #
+  module API
+
+    module Repos
+      module Issues
+        class Proxy < ::Ghee::ResourceProxy
+          def search(term, state = "open")
+            url = "/legacy/issues/search/#{@repo.repo_name}/#{state}/#{term}"
+            Ghee::API::Search::Issues::Proxy.new(connection, url)
+          end
+        end
+      end
+    end
+
+    # The Search module handles all of the Github Search
+    # API endpoints
+    #
+    module Search
+      module Issues
+        class Proxy < ::Ghee::ResourceProxy
+        end
+      end
+      class Proxy < ::Ghee::ResourceProxy
+        def issues(repo, term, state = "open")
+            url = "/legacy/issues/search/#{repo}/#{state}/#{term}"
+            Issues::Proxy.new(connection, url)
+        end
+      end
+    end
+  end
+
+  def search
+    API::Search::Proxy.new(connection,"")
+  end
+end

data/lib/ghee/connection.rb

@@ -19,16 +19,21 @@ class Ghee
       access_token = hash[:access_token] if hash.has_key?:access_token
       basic_auth = hash[:basic_auth] if hash.has_key?:basic_auth
 
-      super('https://api.github.com') do |builder|
+      super(hash[:api_url] || 'https://api.github.com') do |builder|
+        yield builder if block_given?
         builder.use     FaradayMiddleware::EncodeJson
+        builder.use     FaradayMiddleware::Mashify
         builder.use     FaradayMiddleware::ParseJson
       #  builder.use     Ghee::Middleware::UriEscape
         builder.adapter Faraday.default_adapter
+
+
       end
 
       self.headers["Authorization"] = "token #{access_token}" if access_token
       self.basic_auth(basic_auth[:user_name], basic_auth[:password]) if basic_auth
       self.headers["Accept"] = 'application/json'
+
     end
   end
 end

data/lib/ghee/resource_proxy.rb

@@ -25,6 +25,7 @@ class Ghee
     # path_prefix - String
     #
     def initialize(connection, path_prefix, params = {})
+      params = {} if !params.is_a?Hash
       @connection, @path_prefix, @params = connection, URI.escape(path_prefix), params
     end
 

data/lib/ghee/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 class Ghee
-  VERSION = "0.9.6"
+  VERSION = "0.9.7"
 end

data/spec/ghee/api/events_spec.rb

@@ -10,8 +10,8 @@ describe Ghee::API::Events do
 
   def should_be_an_event(event)
     EventTypes.should include(event['type'])
-    event['repo'].should be_instance_of(Hash)
-    event['actor'].should be_instance_of(Hash)
+    event['repo'].should be_instance_of(Hashie::Mash)
+    event['actor'].should be_instance_of(Hashie::Mash)
     event['created_at'].should_not be_nil
   end
 

data/spec/ghee/api/gists_spec.rb

@@ -7,7 +7,7 @@ describe Ghee::API::Gists do
     gist['url'].should include('https://api.github.com/gists/')
     gist['user']['url'].should include('https://api.github.com/users/')
     gist['created_at'].should_not be_nil
-    gist['files'].should be_instance_of(Hash)
+    gist['files'].should be_instance_of(Hashie::Mash)
     gist['files'].size.should > 0
   end
 

data/spec/ghee/api/gitdata_spec.rb

@@ -60,7 +60,7 @@ describe Ghee::API::Repos::Git do
         before :all do 
           VCR.use_cassette "repos()#git#tags#create" do 
             @test_tag = subject.git.tags.create({
-              :tag => "test_tag_#{rand(100)}",
+              :tag => "#{Guid::guid}",
               :object => subject.commits.first["sha"],
               :type => "commit",
               :message => "creating a tag with the api",

data/spec/ghee/api/issues_spec.rb

@@ -4,12 +4,19 @@ describe Ghee::API::Repos::Issues do
   subject { Ghee.new(GH_AUTH) }
 
   def should_be_an_issue(issue)
-    issue["user"]["login"].should_not be_nil
+    issue["user"].should_not be_nil
     issue["comments"].should_not be_nil
   end
 
   describe "#repos(login,name)#issues" do
     it "should return repos issues" do
+      VCR.use_cassette("repos(\"#{GH_USER}/#{GH_REPO}\").issues") do
+        issues = subject.repos("#{GH_USER}/#{GH_REPO}").issues
+        issues.size.should > 0
+        should_be_an_issue(issues.first)
+      end
+    end
+    it "should accept only one argument" do
       VCR.use_cassette("repos(#{GH_USER},#{GH_REPO}).issues") do
         issues = subject.repos(GH_USER, GH_REPO).issues
         issues.size.should > 0
@@ -17,6 +24,17 @@ describe Ghee::API::Repos::Issues do
       end
     end
 
+    describe "#repos#issues#search" do
+      it "should return open issues by default" do 
+        VCR.use_cassette("repos(#{GH_USER},#{GH_REPO}).issues.search#default") do
+          issues = subject.repos(GH_USER, GH_REPO).issues.search("Seeded")
+          issues.issues.size.should > 0
+          should_be_an_issue(issues.issues.first)
+        end
+
+      end
+    end
+
     describe "#repos(login,name)#issues#closed" do
       it "should return repos closed issues" do
         VCR.use_cassette("repos(#{GH_USER},#{GH_REPO}).issues.closed") do

data/spec/ghee/api/milestones_spec.rb

@@ -13,7 +13,7 @@ describe Ghee::API::Repos::Milestones do
   describe "#repos(login,name)#milestones" do
     it "should return repos milestones" do
       VCR.use_cassette("repos(#{GH_USER},#{GH_REPO}).milestones") do
-        temp_milestone = subject.repos(GH_USER, GH_REPO).milestones.create({ :title => "Destroy test milestone #{rand(100)}" })
+        temp_milestone = subject.repos(GH_USER, GH_REPO).milestones.create({ :title => "Destroy test milestone #{Guid::guid}" })
 
         milestones = subject.repos(GH_USER, GH_REPO).milestones
         milestones.size.should > 0
@@ -26,7 +26,7 @@ describe Ghee::API::Repos::Milestones do
     describe "#repos(login,name)#milestones#closed" do
       it "should return repos closed milestones" do
         VCR.use_cassette("repos(#{GH_USER},#{GH_REPO}).milestones.closed") do
-          temp_milestone = subject.repos(GH_USER, GH_REPO).milestones.create({ :title => "Destroy test milestone #{rand(100)}" })
+          temp_milestone = subject.repos(GH_USER, GH_REPO).milestones.create({ :title => "Destroy test milestone #{Guid::guid}" })
           subject.repos(GH_USER, GH_REPO).milestones(temp_milestone["number"]).close
 
           milestones = subject.repos(GH_USER, GH_REPO).milestones.closed
@@ -44,7 +44,7 @@ describe Ghee::API::Repos::Milestones do
     describe "#repos(login,name)#milestones(1)" do
       it "should return an milestone by id" do
         VCR.use_cassette("repos(#{GH_USER},#{GH_REPO}).milestones(1)") do
-          temp_milestone = subject.repos(GH_USER, GH_REPO).milestones.create({ :title => "Destroy test milestone #{rand(100)}" })
+          temp_milestone = subject.repos(GH_USER, GH_REPO).milestones.create({ :title => "Destroy test milestone #{Guid::guid}" })
 
           milestone = subject.repos(GH_USER, GH_REPO).milestones(1)
           should_be_an_milestone(milestone)
@@ -58,7 +58,7 @@ describe Ghee::API::Repos::Milestones do
           VCR.use_cassette "milestones(id).destroy" do
             repo = subject.repos(GH_USER, GH_REPO)
             test_milestone = repo.milestones.create({
-              :title => "Destroy test milestone #{rand(100)}"
+              :title => "Destroy test milestone #{Guid::guid}"
             })
             should_be_an_milestone(test_milestone)
             subject.repos(GH_USER, GH_REPO).milestones(test_milestone["number"]).destroy.should be_true
@@ -72,7 +72,7 @@ describe Ghee::API::Repos::Milestones do
           VCR.use_cassette "milestones.test" do
             @repo = subject.repos(GH_USER, GH_REPO)
             @test_milestone = @repo.milestones.create({
-              :title => "Test milestone #{rand(100)}"
+              :title => "Test milestone #{Guid::guid}"
             })
           end
         end

data/spec/ghee/api/repos_spec.rb

@@ -64,7 +64,7 @@ describe Ghee::API::Repos do
 
         it "should patch a label" do
           VCR.use_cassette("repo(#{GH_USER},#{GH_REPO}).labels.patched") do
-            name = "patch label #{rand(100)}"
+            name = "patch label #{Guid::guid}"
             label = subject.repos(GH_USER, GH_REPO).labels.create(:color => "efefef", :name => name)
             label["color"].should == "efefef"
             label["url"].should include "labels/patch"

data/spec/ghee/api/search_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Ghee::API::Search do
+  subject { Ghee.new(GH_AUTH) }
+
+  def should_be_an_issue(issue)
+    issue["user"].should_not be_nil
+    issue["comments"].should_not be_nil
+  end
+
+  describe "gh#search#issues" do
+    it "should search open issues by repo by default" do 
+      VCR.use_cassette "gh#search#issues#default" do
+        issues = subject.search.issues("#{GH_USER}/#{GH_REPO}", "Seeded")
+        issues.issues.size.should > 0
+        should_be_an_issue(issues.issues.first)
+      end
+    end
+  end
+end

data/spec/ghee/connection_spec.rb

@@ -17,12 +17,12 @@ describe Ghee::Connection do
         end
       end
 
-      it "should return 204" do
-        response.status.should == 204
+      it "should return 200" do
+        response.status.should == 200
       end
 
       it "should parse the json response" do
-        response.body.should be_nil
+        response.body.should_not be_nil
       end
     end
   end
@@ -42,12 +42,12 @@ describe Ghee::Connection do
           subject.get('/')
         end
       end
-      it "should return 204" do
-        response.status.should == 204
+      it "should return 200" do
+        response.status.should == 200
       end
 
       it "should parse the json response" do
-        response.body.should be_nil
+        response.body.should_not be_nil
       end
     end
   end

data/spec/ghee/memory_cache_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+class TestCache < Hash
+    def read(key)
+      if cached = self[key]
+        Marshal.load(cached)
+      end
+    end
+
+    def write(key, data)
+      self[key] = Marshal.dump(data)
+    end
+
+    def fetch(key)
+      read(key) || yield.tap { |data| write(key, data) }
+    end
+  end
+@cache = TestCache.new
+
+describe Ghee::Connection do 
+  context "with custom cache middleware" do 
+    before :all do 
+      @cache = TestCache.new
+      @connection =  connection =  Ghee::Connection.new(GH_AUTH) do |conn|
+                conn.use FaradayMiddleware::Caching, @cache
+              end
+
+    end
+    let( :connection ){@connection}
+    describe "authorization request" do 
+      it "should make one request only" do
+        VCR.use_cassette "cached auth" do
+          connection.get("/").status.should == 200
+        end
+        # this will throw a cassette warning if
+        # it makes another request
+        connection.get("/").status.should == 200
+
+      end
+    end
+  end
+end

data/spec/ghee_spec.rb

@@ -35,7 +35,6 @@ describe Ghee do
       it "should set up a connection" do
         gh = Ghee.new
         gh.connection.should be_instance_of(Ghee::Connection)
-        gh.connection.hash.should == {}
       end
     end
   end

data/spec/spec_helper.rb

@@ -4,6 +4,7 @@ Bundler.require :default, :test
 require 'webmock/rspec'
 require 'vcr'
 require 'ghee'
+require 'uuidtools'
 
 VCR.config do |c|
   c.cassette_library_dir = File.expand_path('../responses', __FILE__)
@@ -18,3 +19,8 @@ else
   GH_AUTH = {:access_token => ENV["TOKEN"]}
   GH_USER, GH_REPO, GH_ORG = ENV['GH_USER'], ENV['GH_REPO'], ENV['GH_ORG']
 end
+class Guid
+  def self.guid
+    UUIDTools::UUID.timestamp_create().to_s
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ghee
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 0.9.7
   prerelease: 
 platform: ruby
 authors:
@@ -10,55 +10,55 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-02 00:00:00.000000000Z
+date: 2012-12-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70221585006860 !ruby/object:Gem::Requirement
+  requirement: &70193822854740 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70221585006860
+  version_requirements: *70193822854740
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70221585006420 !ruby/object:Gem::Requirement
+  requirement: &70193822854260 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *70221585006420
+  version_requirements: *70193822854260
 - !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: &70221585006000 !ruby/object:Gem::Requirement
+  name: hashie
+  requirement: &70193822853800 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70221585006000
+  version_requirements: *70193822853800
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
-  requirement: &70221585005580 !ruby/object:Gem::Requirement
+  name: multi_json
+  requirement: &70193822853340 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70221585005580
+  version_requirements: *70193822853340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70221585005160 !ruby/object:Gem::Requirement
+  requirement: &70193822852960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221585005160
+  version_requirements: *70193822852960
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &70221585004740 !ruby/object:Gem::Requirement
+  requirement: &70193822852500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221585004740
+  version_requirements: *70193822852500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70221585004240 !ruby/object:Gem::Requirement
+  requirement: &70193824944280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: 2.9.0
   type: :development
   prerelease: false
-  version_requirements: *70221585004240
+  version_requirements: *70193824944280
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70221585003820 !ruby/object:Gem::Requirement
+  requirement: &70193824943860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221585003820
+  version_requirements: *70193824943860
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70221585003360 !ruby/object:Gem::Requirement
+  requirement: &70193824943400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -110,10 +110,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221585003360
+  version_requirements: *70193824943400
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70221587187880 !ruby/object:Gem::Requirement
+  requirement: &70193824942980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -121,10 +121,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221587187880
+  version_requirements: *70193824942980
 - !ruby/object:Gem::Dependency
   name: autotest-growl
-  requirement: &70221587187460 !ruby/object:Gem::Requirement
+  requirement: &70193824942560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70193824942560
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: &70193824942140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,7 +143,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70221587187460
+  version_requirements: *70193824942140
 description: A complete, simple, and intuitive ruby API for all things Github.
 email:
 - rauh.ryan@gmail.com
@@ -169,6 +180,7 @@ files:
 - lib/ghee/api/orgs.rb
 - lib/ghee/api/pulls.rb
 - lib/ghee/api/repos.rb
+- lib/ghee/api/search.rb
 - lib/ghee/api/users.rb
 - lib/ghee/api/watchers.rb
 - lib/ghee/connection.rb
@@ -188,9 +200,11 @@ files:
 - spec/ghee/api/milestones_spec.rb
 - spec/ghee/api/orgs_spec.rb
 - spec/ghee/api/repos_spec.rb
+- spec/ghee/api/search_spec.rb
 - spec/ghee/api/teams_spec.rb
 - spec/ghee/api/users_spec.rb
 - spec/ghee/connection_spec.rb
+- spec/ghee/memory_cache_spec.rb
 - spec/ghee/resource_proxy_spec.rb
 - spec/ghee_spec.rb
 - spec/settings.yml.sample
@@ -233,9 +247,11 @@ test_files:
 - spec/ghee/api/milestones_spec.rb
 - spec/ghee/api/orgs_spec.rb
 - spec/ghee/api/repos_spec.rb
+- spec/ghee/api/search_spec.rb
 - spec/ghee/api/teams_spec.rb
 - spec/ghee/api/users_spec.rb
 - spec/ghee/connection_spec.rb
+- spec/ghee/memory_cache_spec.rb
 - spec/ghee/resource_proxy_spec.rb
 - spec/ghee_spec.rb
 - spec/settings.yml.sample