github-api-client 0.3.3 → 0.4.0.pre

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+/doc/
+.yardoc
+*.swp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -1,17 +1,3 @@
 source "http://rubygems.org"
 
-gem "rainbow", ">= 1.1.3"
-gem "rake", "0.8.7"
-gem "activerecord", ">= 3.1.0"
-gem "activesupport", ">= 3.1.0"
-gem "sqlite3", ">= 1.3.5"
-gem "OptionParser", ">= 0.5.1"
-
-group :development do
-  gem "rspec", ">= 2.7.0"
-  gem "mocha", ">= 0.10.0"
-  gem "yard", ">= 0.6.0"
-  gem "cucumber", ">= 1.1.4"
-  gem "jeweler", ">= 1.6.4"
-  gem "rcov", ">= 0.9.11"
-end
+gemspec

data/Gemfile.lock

@@ -1,19 +1,30 @@
+PATH
+  remote: .
+  specs:
+    github-api-client (0.4.0.pre)
+      OptionParser (>= 0.5.1)
+      activerecord (>= 3.1.0)
+      activesupport (>= 3.1.0)
+      rainbow (>= 1.1.3)
+      rake (= 0.8.7)
+      sqlite3 (>= 1.3.5)
+
 GEM
   remote: http://rubygems.org/
   specs:
     OptionParser (0.5.1)
-    activemodel (3.1.3)
-      activesupport (= 3.1.3)
+    activemodel (3.2.1)
+      activesupport (= 3.2.1)
       builder (~> 3.0.0)
-      i18n (~> 0.6)
-    activerecord (3.1.3)
-      activemodel (= 3.1.3)
-      activesupport (= 3.1.3)
-      arel (~> 2.2.1)
+    activerecord (3.2.1)
+      activemodel (= 3.2.1)
+      activesupport (= 3.2.1)
+      arel (~> 3.0.0)
       tzinfo (~> 0.3.29)
-    activesupport (3.1.3)
+    activesupport (3.2.1)
+      i18n (~> 0.6)
       multi_json (~> 1.0)
-    arel (2.2.1)
+    arel (3.0.0)
     builder (3.0.0)
     cucumber (1.1.4)
       builder (>= 2.1.2)
@@ -22,22 +33,16 @@ GEM
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.6)
     diff-lcs (1.1.3)
-    gherkin (2.7.3)
+    gherkin (2.7.6)
       json (>= 1.4.6)
-    git (1.2.5)
     i18n (0.6.0)
-    jeweler (1.6.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
     json (1.6.5)
     metaclass (0.0.1)
-    mocha (0.10.2)
+    mocha (0.10.3)
       metaclass (~> 0.0.1)
     multi_json (1.0.4)
     rainbow (1.1.3)
     rake (0.8.7)
-    rcov (0.9.11)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -55,15 +60,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  OptionParser (>= 0.5.1)
-  activerecord (>= 3.1.0)
-  activesupport (>= 3.1.0)
   cucumber (>= 1.1.4)
-  jeweler (>= 1.6.4)
+  github-api-client!
   mocha (>= 0.10.0)
-  rainbow (>= 1.1.3)
-  rake (= 0.8.7)
-  rcov (>= 0.9.11)
   rspec (>= 2.7.0)
-  sqlite3 (>= 1.3.5)
   yard (>= 0.6.0)

data/NEWS

@@ -0,0 +1,18 @@
+github-api-client NEWS -- history of user-visible changes
+updated at 2011/01/30
+
+Version 0.4.0.pre
+* This version serves the purpose of showing new features and new design that github-api-client implemented recently
+* New design
+  focuses on splitting the logic into:
+    - Models (backend)      - generally hidden from end-user
+    - Fetchers (frontend)   - retrieve data from the site and store them locally using strategies
+      * Strategy            - defines when to refresh data
+    - Resources (frontend)  - light objects with @attributes hash and defined accessors for fields (also for editable fields)
+
+* Resource description
+  classes like Repository or User are now inheriting from Resource class which generates accessor methods for them and more
+
+* Fully dynamic models and migrations generation
+  taking advantage from using Resource classes to describe API resources, migrations now create tables for every resource
+  models also include associations defined in Resource classes

data/Rakefile

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+require 'rubygems'
+require 'bundler'
+include Rake::DSL
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+include Rake::DSL # supressess jeweler warnings
+
+desc 'run irb session against this library'
+task :irb do
+  system 'irb -I./lib -r github-api-client'
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/TODO

@@ -0,0 +1,6 @@
+* checking how many requests are left (from http headers [caching preffered from last request])
+* helper methods for fetching data
+  | writing GitHub::Fetchers::Repository.get(resource_user.login + '/' + resource_user.repos.select{|repo| repo.name == 'github-api-client'}) # is not fun!
+  | rethink design fetchers?
+* helpers for choosing strategy (maybe providing short descriptions?)
+* use minitest for testing with rspec matchers

data/bin/api-browser.rb

@@ -2,22 +2,17 @@
 
 $:.unshift File.expand_path('../lib', File.dirname(__FILE__))
 
-require 'github-api-client'
+require 'github-api-client/resource'
 
-puts GitHub::Config::Version
-
-unless ARGV.include? 'test'
-  # Dev temporary code here
-  # GitHub::Repo.get('parndt/hub').parent.fetch(:self, :watchers).watchers
-  org = GitHub::Organization.get('github').fetch(:members, :repositories)
-  p org.repositories.collect {|r| r.name}
-  p org.members.collect {|u| u.login}
-else # launches all-features code
-  # Performance tests
-  GitHub::Organization.get('rails').fetch(:repositories).repositories
-  GitHub::Repo.get('parndt/hub').parent.fetch(:self, :watchers).watchers
-  GitHub::Repo.get('rails/rails', :organization).fetch(:self)
-  GitHub::User.get('kneath').fetch(:followers, :followings)
-  GitHub::User.get('schacon').fetch(:organizations).organizations
-  GitHub::Organization.get('github').fetch(:members, :repositories).members
+class User
+  @@attributes = {login: String, name: String, has_repos: true, location: String}
+  @@pushables = [:name, :location]
+	@@associations = {repositories: [nil, -> { has_many :repositories, :class_name => Repo}]}
+  include Resource
 end
+
+u = User.new
+u.name = 'Kuba'
+u.attributes[:has_repos] = true
+u.save
+p u.repositories

data/bin/github-api-client

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'github-api-client'
+
+# These are the default option values. By setting them
+# before we parse the arguments, we make sure we don't have
+# any missing argument wonkyness
+GitHub::Config::Options[:verbose] = false
+GitHub::Config::Options[:server] = 'github.com'
+GitHub::Config::Options[:reset_db] = false
+
+OptionParser.new { |opts|
+
+  opts.on( '-h', '--help', 'Display this screen' ) do
+    puts opts
+  end
+  opts.on( '-v', '--verbose', 'Enable Verbose Output') do
+    GitHub::Config::Options[:verbose] = true
+  end
+  opts.on( '-s', '--server SERVER', 'Change the GitHub server') do |host|
+    GitHub::Config::Options[:server] = host
+  end
+  opts.on( '-r', '--reset-db', 'Reset the database') do
+    GitHub::Config::Options[:reset_db] = true
+  end
+
+}.parse!
+
+GitHub::Config::Options[:reset_db] ? GitHub::Config.reset : GitHub::Config.setup
+
+puts GitHub::Organization.get('rails').fetch(:repositories).repositories.watchers.map { |x| x.attributes }

data/db/migrate/001_migrate_everything.rb

@@ -0,0 +1,18 @@
+require 'active_support/core_ext/string'
+
+class MigrateEverything < ActiveRecord::Migration
+  def change
+    GitHub::Resources.constants.each do |resource|
+      klass = GitHub::Resources.const_get(resource)
+      create_table resource.to_s.pluralize.downcase do |table|
+        klass.class_variable_get(:@@attributes).each_pair do |key, value|
+          table.send(value, key)
+        end
+
+        klass.class_variable_get(:@@associations).each_pair do |key, value|
+          table.references value.first unless value.first.nil?
+        end
+      end
+    end
+  end
+end

data/features/user_api.feature

@@ -0,0 +1,88 @@
+Feature: User frontend
+	In order to use API provided by this library properly
+	I need to use provided set of objects
+  
+	Background:
+		Given the "User" resource
+
+	Scenario: Existence of User class
+		Given I am trying to make use of this library
+		Then "User" resource should exist
+	
+	Scenario: Existence of User resource
+		Given the "User" resource
+		Then the object should exist
+	
+	Scenario: User's name
+		Given the "name" property
+		Then the property should be "Chris Wanstrath"
+			And the property should be writable
+	
+	Scenario: User's location
+		Given the "location" property
+		Then the property should be "San Francisco"
+			And the property should be writable
+	
+	Scenario: User's company
+		Given the "company" property
+		Then the property should be "GitHub"
+			And the property should be writable
+	
+	Scenario: User's login
+		Given the "login" property
+		Then the property should be "defunkt"
+			And the property should not be writable
+	
+	Scenario: User's bio
+		Given the "bio" property
+		Then the property should be "The greatest and best programmer in the world."
+		Then the property should be writable
+	
+	Scenario: User's email
+		Given the "email" property
+		Then the property should be "chris@wanstrath.com"
+			And the property should be writable
+	
+	Scenario: User's hireable status
+		Given the "hireable" property
+		Then the property should be true
+			And the property should be writable
+	
+	Scenario: User's blog
+		Given the "blog" property
+		Then the property should be "http://chriswanstrath.com/"
+			And the property should be writable
+	
+	Scenario: Saving User
+		Given that I am authenticated as this resource
+			And I am tracking browser actions
+		When I set "name" to "test"
+			And I update the resource
+		Then the resource changes should be cleared
+			And the browser fires up a PATCH request at "/user"
+	
+	Scenario: Getting user's public repos
+		Given that I am trying to fetch user's public repos
+			But I am not authenticated
+		When I fetch resource's repositories
+		Then I can access resource's repositories
+			And accessed data should be a set of repositories
+	
+	Scenario: Getting all user's repos
+		Given that I am trying to fetch user's repos
+			And I am authenticated
+		When I fetch resource's repositories
+		Then I can access resource's private repositories
+			And accessed data should be a set of repositories
+	
+	Scenario: Getting user's followers
+		Given that I am trying to fetch resource's followers
+		When I fetch resource's followers
+		Then I can access resource's followers
+			And accessed data should be a set of users
+	
+	Scenario: Getting user's followings
+		Given that I am trying to fetch resource's followings
+		When I fetch resource's followings
+		Then I can access resource's followings
+			And accessed data should be a set of users

data/github-api-client.gemspec

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+$:.unshift File.expand_path("../lib", __FILE__)
+require "github-api-client/version"
+
+Gem::Specification.new do |s|
+  s.name = "github-api-client"
+  s.version = GitHub::Version::String
+
+  s.authors = [%{Jakub Okoński}]
+  s.date = "2012-01-30"
+  s.description = "Caches retrieved information to your user profile and reuses it when you query again."
+  s.email = "kuba@okonski.org"
+  s.executables = ["api-browser.rb github-api-client"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "TODO",
+    "NEWS"
+  ]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  
+  s.homepage = %{http://github.com/farnoy/github-api-client}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.summary = %{Library for easy GitHub API browsing}
+
+  s.add_runtime_dependency("rainbow", [">= 1.1.3"])
+  s.add_runtime_dependency("rake", ["= 0.8.7"])
+  s.add_runtime_dependency("activerecord", [">= 3.1.0"])
+  s.add_runtime_dependency("activesupport", [">= 3.1.0"])
+  s.add_runtime_dependency("sqlite3", [">= 1.3.5"])
+  s.add_runtime_dependency("OptionParser", [">= 0.5.1"])
+
+  s.add_development_dependency("rspec", [">= 2.7.0"])
+  s.add_development_dependency("mocha", [">= 0.10.0"])
+  s.add_development_dependency("yard", [">= 0.6.0"])
+  s.add_development_dependency("cucumber", [">= 1.1.4"])
+end

data/lib/github-api-client.rb

@@ -6,12 +6,27 @@ $:.unshift File.dirname(__FILE__)
 
 require 'net/http'
 require 'uri'
-require 'yaml'
+require 'json'
 require 'singleton'
 require 'active_record'
 require 'core_ext/habtm'
 require 'rainbow'
+require 'github-api-client/version'
 require 'github-api-client/config'
+require 'github-api-client/strategy'
+
+require 'github-api-client/base'
+#require 'github-api-client/user'
+#require 'github-api-client/repo'
+#require 'github-api-client/organization'
+require 'github-api-client/browser'
+require 'github-api-client/helpers'
+
+# Resources
+require 'github-api-client/resource'
+Dir[File.expand_path("github-api-client/resources/*.rb", File.dirname(__FILE__))].each do |lib|
+	require lib
+end
 
 # This hard-coded if's will be soon replaced by Option Parser
 GitHub::Config::Options[:verbose] = true if ARGV.include? '--verbose'
@@ -21,15 +36,22 @@ else
   GitHub::Config.setup
 end
 
-require 'github-api-client/base'
-require 'github-api-client/user'
-require 'github-api-client/repo'
-require 'github-api-client/organization'
-require 'github-api-client/browser'
+# Fetchers
+require 'github-api-client/fetchers'
+Dir[File.expand_path("github-api-client/fetchers/*.rb", File.dirname(__FILE__))].each do |lib|
+	require lib
+end
+
+#unless $user = GitHub::User.where(GitHub::Config::Secrets).first
+#  $user = GitHub::User.create(GitHub::Config::Secrets)
+#end if GitHub::Config::Secrets
+
 
-unless $user = GitHub::User.where(GitHub::Config::Secrets).first
-  $user = GitHub::User.create(GitHub::Config::Secrets)
-end if GitHub::Config::Secrets
+# Strategies
+require 'github-api-client/strategies/ask'
+require 'github-api-client/strategies/remote'
+require 'github-api-client/strategies/local'
+GitHub::Config::Options[:strategy] = GitHub::Strategies::Ask # GitHub::CachingStrategy
 
 
 # General placeholder for all of the GitHub API sweets