fcoury-octopi 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Felipe Coury
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,53 @@
+= octopi
+
+Octopi is a Ruby interface to GitHub API v2 (http://developer.github.com). It's under early but active development and already works.
+
+== Example
+
+  require 'octopi'
+
+  include Octopi
+
+  # user information
+  user = User.find("fcoury")
+  puts "#{user.name} is being followed by #{user.followers.join(", ")} and following #{user.following.join(", ")}"
+
+  # the bang version of followers and following 
+  # fetches user object for each user, but is 
+  # a lot more expensive
+  user.followers!.each do |u|
+    puts "  - #{u.name} (#{u.login}) has #{u.public_repo_count} repo(s)"
+  end
+
+  # search user
+  users = User.find_all("silva")
+  puts "#{users.size} users found for 'silva':"
+  users.each do |u|
+    puts "  - #{u.name}"
+  end
+
+  # repository information
+  repo = Repository.find("fcoury", "octopi")
+  puts "Repository: #{repo.name} - #{repo.description} (by #{repo.owner}) - #{repo.url}"
+
+  # repository search
+  repos = Repository.find_all("ruby", "git")
+  puts "#{repos.size} repository(ies) with 'ruby' and 'git':"
+  repos.each do |r|
+    puts "  - #{r.name}"
+  end
+
+  # connect "user", "<<token>>" do |github|
+  #   puts github.user.name
+  # end
+
+== Author
+
+Felipe Coury - http://felipecoury.com
+HasMany.info blog - http://hasmany.info
+
+== Copyright
+
+DISCLAIMER: The name of this library is pronounced _octo-pie_ but no Octocats were harmed during its creation. It's not really an Octo Pie, but a contraction of the words Octocat and API.
+
+Copyright (c) 2009 Felipe Coury. See LICENSE for details.

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 0
+:patch: 1
+:major: 0

data/lib/octopi.rb

@@ -0,0 +1,191 @@
+require 'rubygems'
+require 'httparty'
+require 'pp'
+
+module Octopi
+  class Api; end
+  ANONYMOUS_API = Api.new
+  
+  def connect(login, token, &block)
+    yield Api.new(login, token)
+  end
+  
+  class Api
+    include HTTParty
+    base_uri "http://github.com/api/v2"
+  
+    attr_accessor :format
+  
+    def initialize(login = nil, token = nil, format = "xml")
+      self.class.default_params(:login => login, :token => token) if login
+      @format = format
+    end
+  
+    %w[keys emails].each do |action|
+      define_method("#{action}") do
+        get("/user/#{action}")
+      end
+    end
+
+    def user
+      user_data = get("/user/show/#{self.class.default_params[:login]}")
+      raise "Unexpected response for user command" unless user_data and user_data['user']
+      User.new(self, user_data['user'])
+    end
+    
+    def save(resource_path, data)
+      traslate resource_path, data
+      #still can't figure out on what format values are expected
+      post("#{resource_path}", { :query => data })
+    end
+    
+    def find(path, result_key, resource_id)
+      get(path, { :id => resource_id }) 
+    end
+
+    def find_all(path, result_key, query)
+      get(path, { :query => query })[result_key]
+    end
+  
+    private
+    def get(path, params = {}, format = "yaml")
+      params.each_pair do |k,v|
+        path = path.gsub(":#{k.to_s}", v)
+      end
+      # puts "GET: /#{format}#{path}"
+      self.class.get("/#{format}#{path}")
+    end
+  end
+  
+  class Base
+    def initialize(api, hash)
+      @api = api
+      @keys = []
+      
+      raise "Missing data for #{@resource}" unless hash
+      
+      hash.each_pair do |k,v|
+        @keys << k
+        instance_variable_set("@#{k}", v)
+        
+        self.class.send :define_method, "#{k}=" do |v|
+          instance_variable_set("@#{k}", v)
+        end
+
+        self.class.send :define_method, k do
+          instance_variable_get("@#{k}")
+        end
+      end
+    end
+    
+    def property(p, v)
+      path = "#{self.class.path_for(:resource)}/#{p}"
+      @api.find(path, self.class.resource_name(:singular), v)
+    end
+    
+    def save
+      hash = {}
+      @keys.each { |k| hash[k] = send(k) }
+      @api.save(self.path_for(:resource), hash)
+    end
+  end
+  
+  module Resource
+    def self.included(base)
+      base.extend ClassMethods
+      base.set_resource_name(base.name)
+      (@@resources||={})[base.resource_name(:singular)] = base
+      (@@resources||={})[base.resource_name(:plural)] = base
+    end
+    
+    def self.for(name)
+      @@resources[name]
+    end
+    
+    module ClassMethods
+      def set_resource_name(singular, plural = "#{singular}s")
+        @resource_name = {:singular => declassify(singular), :plural => declassify(plural)}
+      end
+      
+      def resource_name(key)
+        @resource_name[key]
+      end
+      
+      def declassify(s)
+        (s.split('::').last || '').downcase if s
+      end
+    
+      def find_path(path)
+        (@path_spec||={})[:find] = path
+      end
+    
+      def resource_path(path)
+        (@path_spec||={})[:resource] = path
+      end
+    
+      def find(s)
+        result = ANONYMOUS_API.find(path_for(:resource), @resource_name[:singular], s)
+        key = result.keys.first
+        Resource.for(key).new(ANONYMOUS_API, result[key])
+      end
+      
+      def find_all(s)
+        all = []
+        result = ANONYMOUS_API.find_all(path_for(:find), @resource_name[:plural], s)
+        result.each do |item|
+          all << new(ANONYMOUS_API, item)
+        end
+        all
+      end
+    
+      def path_for(type)
+        @path_spec[type]
+      end
+    end
+  end
+  
+  class User < Base
+    include Resource
+    
+    find_path "/user/search/:query"
+    resource_path "/user/show/:id"
+    
+    def user_property(property, deep)
+      users = []
+      property(property, login).each_pair do |k,v|
+        return v unless deep
+        
+        v.each { |u| users << User.find(u) } 
+      end
+      
+      users
+    end
+    
+    # takes one param, deep that indicates if returns 
+    # only the user login or an user object
+    %w[followers following].each do |method|
+      define_method(method) do
+        user_property(method, false)
+      end
+      define_method("#{method}!") do
+        user_property(method, true)
+      end
+    end
+  end
+  
+  class Repository < Base
+    include Resource
+    set_resource_name "repository", "repositories"
+    
+    def self.find(user, name)
+      super "#{user}/#{name}"
+    end
+    
+    def self.find_all(*args)
+      super args.join("+")
+    end
+
+    find_path "/repos/search/:query"
+    resource_path "/repos/show/:id"
+  end
+end

data/test/octopi_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class OctopiTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'octopi'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: fcoury-octopi
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Felipe Coury
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-19 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: felipe.coury@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- README.rdoc
+- VERSION.yml
+- lib/octopi.rb
+- test/octopi_test.rb
+- test/test_helper.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/fcoury/octopi
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Ruby interface to GitHub API v2
+test_files: []
+