octoplex 0.0.2 → 0.0.3

data/Gemfile

@@ -1,4 +1,5 @@
 source "http://rubygems.org"
 
+gem 'rake', '~> 0.9.2'
 # Specify your gem's dependencies in octoplex.gemspec
 gemspec

data/README.md

@@ -56,6 +56,66 @@ Octoplex.rate_limit #=> 5000
 Octoplex.rate_limit_remaining #=> 4999
 ```
 
+There are times when you may want to run multiple instances of the `Octoplex::Client` side by side
+with different tokens.
+
+The recommended approach for this is to not use the global `Octoplex` object, rather instantiate `Octoplex::Client`
+individually.
+
+``` ruby
+client = Octoplex::Client.new(:token => "AUTH_TOKEN")
+client.get('/user')
+```
+
+### Configuration
+
+You can specify a number of connection options before making your first request, but remember, the connection object is cached so you will
+need to call `Octoplex.discard_client!` if you want to change anything.
+
+Available options:
+``` ruby
+{
+  :token => YOU OAUTH AUTHENTICATION TOKEN, Default: nil,
+  :per_page => THE NUMBER OF ITEMS TO REQUEST AT ONCE, Default: 100,
+  :enable_caching, ENABLE REQUEST CACHING, Default: true
+}
+```
+Pass these to `Octoplex.client(options)`
+
+### Repositories
+
+Here is a quick rundown on using `Octoplex` to interact with Repositories.
+
+**List all for a user**
+``` ruby
+Octoplex.repos('ivanvanderbyl')
+# or, take the object orientated approach
+Octoplex.users('testpilot').repos
+```
+
+**List all for the current user**
+``` ruby
+Octoplex.repos
+# or
+Octoplex.user.repos
+```
+
+**Fetch a specific repo**
+``` ruby
+Octoplex.repo('ivanvanderbyl/cloudist')
+# or
+Octoplex.repo('ivanvanderbyl', 'cloudist')
+```
+
+**List all for an Organisation**
+``` ruby
+Octoplex.orgs('testpilot').repos
+# or
+Octoplex.repos('testpilot')
+```
+
+
+
 ### Language note
 
 This library is written in International English, so if you're wondering why we've swapped your Zs for S, and added a U to colour – get a dictionary.

data/lib/octoplex/client/repository.rb

@@ -2,15 +2,6 @@ module Octoplex
   class Client
     class Repository < Base
 
-      attr_reader :owner
-
-      def initialize(owner, client, data)
-        super(client, data)
-        @owner = owner
-      end
-
-
-
       # GET /repos/:user/:repo
 
       # GET /repos/:user/:repo/contributors

data/lib/octoplex/client/root.rb

@@ -2,17 +2,28 @@ module Octoplex
   class Client
     module Root
 
+      # Get a single user
+      #
+      # API:  GET /user
+      #       GET /users/:login
+      def user(login=nil)
+        if login
+          users(login)
+        else
+          Octoplex::Client::User.new(self, get("/user"))
+        end
+      end
+
       # GET /users/:user
-      # GET /users/:user/repos
       def users(login)
-        (@users ||= {})[login] ||= Octoplex::API::User.new(self, get("/users/#{login}"))
+        Octoplex::Client::User.new(self, get("/users/#{login}"))
       end
 
-      # GET /user
-      # GET /user/repos
-      def user
-        @user ||= Octoplex::API::User.current
-      end
+      # # GET /user
+      # # GET /user/repos
+      # def user
+      #   @user ||= Octoplex::API::User.current
+      # end
 
       # GET /orgs/:org/repos
       def orgs(login)
@@ -22,16 +33,51 @@ module Octoplex
       alias_method :organisations, :orgs
       alias_method :organizations, :orgs
 
-      # GET /repos/:user/:repo
+
       # GET /repos/:user/:repo/contributors
       # GET /repos/:user/:repo/languages
       # GET /repos/:user/:repo/teams
       # GET /repos/:user/:repo/branches
 
-      def repos(user, repo)
-        (@repos ||= {})[user] ||= Octoplex::API::Repository.new(user, self, get("/repos/#{user}"))
+      # GET /repos/:user/:repo
+      #
+      # Accepts either a user name and repo name as 2 arguments or one.
+      # Example:
+      #   Octoplex.repo('ivanvanderbyl/cloudist')
+      #   Octoplex.repo('ivanvanderbyl', 'cloudist')
+      def repos(*user_and_repo)
+        if user_and_repo.size == 2
+          # We've been supplied two arguments
+          user = user_and_repo[0]
+          repo = user_and_repo[1]
+        elsif user_and_repo.first.is_a?(String) && !user_and_repo.first.index('/').nil?
+          # We've been supplied a string like "ivanvanderbyl/cloudist"
+          user, repo = user_and_repo[0].split('/', 2)
+        elsif user_and_repo.size == 1
+          # We've been supplied one argument, probably a username
+          user = user_and_repo[0]
+          repo = nil
+        else
+          raise ArgumentError, "Unknown arguments: #{user_and_repo.split(', ')}"
+        end
+        if repo.nil?
+          path = "/users/#{user}/repos"
+        else
+          path = "/repos/#{user}/#{repo}"
+        end
+
+        data = get(path)
+        if data.is_a?(Array)
+          data.map { |o| Octoplex::Client::Repository.new(self, o) }
+        else
+          Octoplex::Client::Repository.new(self, data)
+        end
       end
 
+      alias_method :repo, :repos
+      alias_method :repositories, :repos
+      alias_method :repository, :repos
+
     end
   end
 end

data/lib/octoplex/client/user.rb

@@ -1,27 +1,10 @@
 module Octoplex
   class Client
-    class Users < Base
+    class User < Base
 
-
-
-      # class << self
-      #   def find(client, login)
-      #     new(client.get("/users/#{login}"))
-      #   end
-      #
-      #   def current(client)
-      #     new(client.get("/user"))
-      #   end
-      # end
-
-      # GET /users/:user/[repos]
-      # def repos
-      #   Octoplex::API::Repository.all
-      #   # get("/user/#{login}/repos")
-      # end
-
-      def repos
-        Octoplex::API::Repository.new(login, self, get("/users/repos"))
+      # GET /repos/:user/:repo
+      def repos(repo)
+        Octoplex::Client::Repository.new(client, "/repos/#{login}/#{repo}")
       end
 
     end

data/lib/octoplex/connection.rb

@@ -6,17 +6,25 @@ require "faraday/response/raise_octoplex_error"
 module Octoplex
   class Connection
 
-    attr_reader :conn, :options, :token, :rate_limit, :rate_limit_remaining
+    attr_reader :conn, :options, :conn_options, :token, :rate_limit, :rate_limit_remaining
 
     def initialize(options = {})
       options ||= {}
 
       @options = {
-        :token => nil,
-        :per_page => 100
+        :per_page => 100,
+        :enable_caching => true,
+        :logging => false,
+        :token => nil
       }.update(options)
 
-      @token = options.delete(:token)
+      @conn_options = {
+        :logging => @options.delete(:logging),
+        :access_token => @options.delete(:token),
+        :enable_caching => @options.delete(:enable_caching)
+      }
+
+      @token = @conn_options[:access_token]
       @rate_limit = @rate_limit_remaining = 0
       setup
     end
@@ -24,7 +32,7 @@ module Octoplex
     def setup
       @conn = Faraday.new(:url => 'https://api.github.com') do |builder|
         builder.use Faraday::Request::JSON
-        builder.use Faraday::Response::Logger
+        builder.use Faraday::Response::Logger if conn_options[:logging].eql?(true)
         builder.use Faraday::Adapter::NetHttp
         builder.use Faraday::Response::Hashr
         builder.use Faraday::Response::RaiseOctoplexError
@@ -52,13 +60,46 @@ module Octoplex
       request(path, :delete)
     end
 
+    def cache(path, response)
+      if options[:enable_caching] == true
+        (@cache ||= {})[path.to_s] = response
+      end
+      response
+    end
+
+    def cached(path)
+      (@cache ||= {})[path.to_s]
+    end
+
+    def is_cached?(path)
+      (@cache ||= {}).has_key?(path)
+    end
+
+    def clear_cache
+      @cache = {}
+    end
+
+    def cache_size
+      (@cache ||= {}).keys.size
+    end
+
     private
 
     def request(path, method = :get, body = nil)
+      if is_cached?(path)
+        return cached(path)
+      end
+
+      data = make_request(path, method, body)
+      cache(path, data)
+    end
+
+    def make_request(path, method = :get, body = nil)
       response = conn.send(method) do |req|
-        req.url(path, options)
+        req.url(path)
         req.body = body unless body.nil?
-        req.params['access_token'] = self.token if self.token.is_a?(String)
+        req.params.merge!(authentication_param) if self.token.is_a?(String)
+        req.params['per_page'] = self.options[:per_page] if (self.options.has_key?(:per_page) && method == :get)
       end
 
       if response.env[:response_headers].has_key?('x-ratelimit-limit')
@@ -70,5 +111,4 @@ module Octoplex
     end
 
   end
-
 end

data/lib/octoplex/version.rb

@@ -1,3 +1,3 @@
 module Octoplex
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/railsonfire.yml

@@ -0,0 +1,13 @@
+---
+:test:
+  :commands:
+  - gem install bundler --no-ri --no-rdoc
+  - bundle install --without development production
+  - bundle exec rake spec
+:deploy:
+  :branch: master
+  :commands: []
+:ruby_versions:
+- 1.9.2
+- 1.9.3.rc1
+- 1.8.7

data/spec/lib/octoplex/connection_spec.rb

@@ -24,6 +24,7 @@ describe Octoplex::Connection do
     test = Faraday.new do |builder|
       builder.adapter :test, c do |stub|
         stub.get('/user/keys') {[ 200, {}, user_keys_payload ]}
+        stub.get('/users/ivan/cloudist') {[ 200, {}, JSON.dump({:login => 'ivan'})]}
         stub.post('/user/keys/123') {[ 200, {}, JSON.dump(user_key) ]}
       end
 
@@ -44,7 +45,31 @@ describe Octoplex::Connection do
   end
 
   it "should return accept token as first argument" do
-    conn = Octoplex::Connection.new('1234')
+    conn = Octoplex::Connection.new(:token => '1234')
     conn.token.should == '1234'
   end
-end
+
+  describe "caching" do
+    it "should cache each request and it's response" do
+      conn = Octoplex::Connection.new(:token => '1234')
+      conn.expects(:cached).with('/users/ivan/cloudist').returns({'login' => 'ivan'}).once
+
+      conn.get('/users/ivan/cloudist').should == {'login' => 'ivan'}
+      # This second request should hit cache
+      # and avoid caching the resuult
+      conn.expects(:cache).with('/users/ivan/cloudist', {'login' => 'ivan'}).never
+      conn.get('/users/ivan/cloudist').should == {'login' => 'ivan'}
+    end
+
+    it "should not cache response if caching is disabled" do
+      conn = Octoplex::Connection.new(:token => '1234', :enable_caching => false)
+      conn.expects(:cached).with('/users/ivan/cloudist').never
+
+      conn.get('/users/ivan/cloudist').should == {'login' => 'ivan'}
+      # This second request should hit cache
+      # and avoid caching the resuult
+      conn.expects(:cache).with('/users/ivan/cloudist', {'login' => 'ivan'}).returns({'login' => 'ivan'}).once
+      conn.get('/users/ivan/cloudist').should == {'login' => 'ivan'}
+    end
+  end
+end

data/spec/lib/octoplex_spec.rb

@@ -8,4 +8,4 @@ describe Octoplex do
       Octoplex.instance_variable_get("@client").should be_a Octoplex::Client
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octoplex
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-05 00:00:00.000000000 Z
+date: 2011-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70219242559780 !ruby/object:Gem::Requirement
+  requirement: &70217171120640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70219242559780
+  version_requirements: *70217171120640
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70219242555300 !ruby/object:Gem::Requirement
+  requirement: &70217171120220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70219242555300
+  version_requirements: *70217171120220
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70219242551960 !ruby/object:Gem::Requirement
+  requirement: &70217171119800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70219242551960
+  version_requirements: *70217171119800
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70219242548380 !ruby/object:Gem::Requirement
+  requirement: &70217171119380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70219242548380
+  version_requirements: *70217171119380
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70219242545120 !ruby/object:Gem::Requirement
+  requirement: &70217171118960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70219242545120
+  version_requirements: *70217171118960
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70219242543700 !ruby/object:Gem::Requirement
+  requirement: &70217154190020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70219242543700
+  version_requirements: *70217154190020
 - !ruby/object:Gem::Dependency
   name: hashr
-  requirement: &70219242542420 !ruby/object:Gem::Requirement
+  requirement: &70217154189600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70219242542420
+  version_requirements: *70217154189600
 - !ruby/object:Gem::Dependency
   name: link_header
-  requirement: &70219242539740 !ruby/object:Gem::Requirement
+  requirement: &70217154189100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -98,7 +98,7 @@ dependencies:
         version: 0.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70219242539740
+  version_requirements: *70217154189100
 description: A lightweight wrapper around the Github v3 API
 email:
 - ivanvanderbyl@me.com
@@ -125,6 +125,7 @@ files:
 - lib/octoplex/errors.rb
 - lib/octoplex/version.rb
 - octoplex.gemspec
+- railsonfire.yml
 - spec/lib/octoplex/api/user_spec.rb
 - spec/lib/octoplex/client_spec.rb
 - spec/lib/octoplex/connection_spec.rb