rest-graph 1.0.0 → 1.1.0

data/CHANGES

@@ -1,5 +1,20 @@
 = rest-graph changes history
 
+== rest-graph 1.1.0 -- 2010-05-13
+* Main repository was moved to http://github.com/cardinalblue/rest-graph
+  Sorry for the inconvenience. I'll keep pushing to both repositories until
+  I am too lazy to do that.
+
+* Better way to deal with default attributes, use class methods.
+
+* If you want to auto load config, do require 'rest-graph/auto_load'
+  if it's rails, it would load the config from config/rest-graph.y(a)ml.
+  if you're using rails plugin, we do require 'rest-graph/auto_load'
+  for you.
+
+* Config could be load manually as well. require 'rest-graph/load_config' and
+  RestGraph::LoadConfig.load_config!('path/to/rest-graph.yaml', 'env')
+
 == rest-graph 1.0.0 -- 2010-05-06
 * now access_token is saved in data attributes.
 * cookies related methods got renamed, and saved all data in RestGraph

data/{README → README.rdoc}

@@ -1,12 +1,11 @@
-= rest-graph 1.0.0
-by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
-  godfat (XD) godfat.org
+= rest-graph 1.1.0
+by Cardinal Blue ( http://cardinalblue.com )
 
 == LINKS:
 
-* {github}[http://github.com/godfat/rest-graph]
+* {github}[http://github.com/cardinalblue/rest-graph]
 * {rubygems}[http://rubygems.org/gems/rest-graph]
-* {rdoc}[http://rdoc.info/projects/godfat/rest-graph]
+* {rdoc}[http://rdoc.info/projects/cardinalblue/rest-graph]
 
 == DESCRIPTION:
 
@@ -31,53 +30,72 @@ by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
                     :auto_decode  => true,    # decode by json
                     :app_id       => '123',
                     :secret       => '1829')
- rg.get('me')
- rg.post('feed/me', :message => 'bread!')
 
- # for rack
- lambda{ |env|
-   rg = RestGraph.new(:app_id => '123', :secret => '1829')
-   rg.parse_rack_env!(env)  # auto save access_token if sig checked
-   rg.access_token # => ...
-   rg.data['uid']  # => facebook uid
- }
+ rg.get('me')       # GET https://graph.facebook.com/me?access_token=...
+ rg.get('4/likes')  # GET https://graph.facebook.com/4/likes?access_token=...
+
+ # GET https://graph.facebook.com/search?q=taiwan&access_token=...
+ rg.get('search', :q => 'taiwan')
+
+ # GET https://graph.facebook.com/me?metadata=1&access_token=...
+ rg.get('me', :metadata => '1')
+
+ # POST https://graph.facebook.com/feed/me?message=bread%21&access_token=...
+ rg.post('feed/me', :message => 'bread!')
 
  # for fully blown cookies hash
  rg = RestGraph.new(:app_id => '123', :secret => '1829')
  rg.parse_cookies!(cookies) # auto save access_token if sig checked
- rg.access_token # => ...
- rg.data['uid']  # => facebook uid
-
- # for fbs in cookies
- app_id = '456'
- rg = RestGraph.new(:app_id => '123', :secret => '1829')
- fbs = cookies["fbs_#{rg.app_id}"]
- rg.parse_fbs!(fbs)         # auto save access_token if sig checked
- rg.access_token # => ...
- rg.data['uid']  # => facebook uid
+ rg.data['uid']             # => facebook uid
 
- # fql query
+ # fql query, same as:
+ # GET https://api.facebook.com/method/fql.query?query=
+ #     SELECT+name+FROM+page+WHERE+page_id%3D%22123%22&
+ #     format=json&access_token=...
  rg.fql('SELECT name FROM page WHERE page_id="123"')
 
+ # default setting:
+ class RestGraph
+   def self.default_app_id
+     '456'
+   end
+
+   def self.default_secret
+     'category theory'
+   end
+ end
+
+ # auto load config
+ require 'rest-graph'
+ require 'rest-graph/auto_load'  # under Rails, load config/rest-graph.yaml
+ RestGraph.new                   # all default options would honor config
+ RestGraph.new(:app_id => '123') # default could be override as well
+
+ # manually load config
+ require 'rest-graph/load_config'
+ RestGraph::LoadConfig.load_config!('path/to/rest-graph.yaml', 'env')
+
+ # see test/config/rest-graph.yaml for an example for config
+
 == REQUIREMENTS:
 
 * tested with MRI 1.8.7 and 1.9.1
 * gem install rest-client
-* gem install json (optional)
+* gem install json      (optional)
 * gem install json_pure (optional)
-* gem install rack (optional, to parse access_token in HTTP_COOKIE)
+* gem install rack      (optional, to parse access_token in HTTP_COOKIE)
 
 == INSTALL:
 
  > gem install rest-graph
  # or if you want rails plugin and bleeding edge
- > script/plugin install git://github.com/godfat/rest-graph.git
+ > script/plugin install git://github.com/cardinalblue/rest-graph.git
 
 == LICENSE:
 
   Apache License 2.0
 
-  Copyright (c) 2010, Lin Jen-Shin (aka godfat 真常)
+  Copyright (c) 2010, Cardinal Blue
 
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.

data/Rakefile

@@ -24,12 +24,12 @@ Bones{
   depend_on 'bacon',   :development => true
 
   name    proj
-  url     "http://github.com/godfat/#{proj}"
-  authors 'Lin Jen-Shin (aka godfat 真常)'
-  email   'godfat (XD) godfat.org'
+  url     "http://github.com/cardinalblue/#{proj}"
+  authors ['Cardinal Blue', 'Lin Jen-Shin (aka godfat 真常)']
+  email   'dev (XD) cardinalblue.com'
 
   history_file   'CHANGES'
-   readme_file   'README'
+   readme_file   'README.rdoc'
    ignore_file   '.gitignore'
   rdoc.include   ['\w+']
   rdoc.exclude   ['test', 'doc', 'Rakefile']
@@ -41,7 +41,3 @@ task :default do
   Rake.application.options.show_task_pattern = /./
   Rake.application.display_tasks_and_comments
 end
-
-task 'doc:rdoc' do
-  sh 'cp -r ~/.gem/ruby/1.9.1/gems/rdoc-2.5.6/lib/rdoc/generator/template/darkfish/* doc/'
-end

data/init.rb

@@ -1 +1,2 @@
 require 'rest-graph'
+require 'rest-graph/auto_load'

data/lib/rest-graph/auto_load.rb

@@ -0,0 +1,4 @@
+
+require 'rest-graph/load_config'
+
+RestGraph::LoadConfig.auto_load!

data/lib/rest-graph/load_config.rb

@@ -0,0 +1,42 @@
+
+require 'erb'
+require 'yaml'
+
+require 'rest-graph'
+
+class RestGraph < RestGraphStruct
+  module LoadConfig
+    module_function
+    def auto_load!
+      LoadConfig.load_if_rails!
+    end
+
+    def load_if_rails!
+      return unless Object.const_defined?(:Rails)
+      root = Rails.root
+      file = ["#{root}/config/rest-graph.yaml", # YAML should use .yaml
+              "#{root}/config/rest-graph.yml"].find{|path| File.exist?(path)}
+      return unless file
+
+      LoadConfig.load_config!(file, Rails.env)
+    end
+
+    def load_config! file, env
+      config   = YAML.load(ERB.new(File.read(file)).result(binding))
+      defaults = config[env]
+      return unless defaults
+
+      mod = Module.new
+      mod.module_eval(defaults.inject([]){ |r, (k, v)|
+        r << <<-RUBY
+               def default_#{k}
+                 # quote strings, leave others free (e.g. false, numbers, etc)
+                 #{v.kind_of?(String) ? "'#{v}'" : v}
+               end
+               RUBY
+      }.join)
+
+      RestGraph.send(:extend, mod)
+    end
+  end
+end

data/lib/rest-graph/version.rb

@@ -1,4 +1,6 @@
 
-class RestGraph
-  VERSION = '1.0.0'
+require 'rest-graph'
+
+class RestGraph < RestGraphStruct
+  VERSION = '1.1.0'
 end

data/lib/rest-graph.rb

@@ -3,18 +3,42 @@ require 'rest_client'
 
 require 'cgi'
 
-class RestGraph < Struct.new(:data, :graph_server, :fql_server,
-                             :accept, :lang, :auto_decode, :app_id, :secret)
-  def initialize o = {}
-    self.graph_server = o[:graph_server] || 'https://graph.facebook.com/'
-    self.fql_server   = o[:fql_server]   || 'https://api.facebook.com/'
-    self.accept       = o[:accept] || 'text/javascript'
-    self.lang         = o[:lang]   || 'en-us'
-    self.auto_decode  = o.key?(:auto_decode) ? o[:auto_decode] : true
-    self.app_id       = o[:app_id]
-    self.secret       = o[:secret]
-    self.access_token = o[:access_token]
+# the data structure used in RestGraph
+RestGraphStruct = Struct.new(:data, :auto_decode,
+                             :graph_server, :fql_server,
+                             :accept, :lang,
+                             :app_id, :secret)
+
+class RestGraph < RestGraphStruct
+  Attributes = RestGraphStruct.members.map(&:to_sym)
+
+  # honor default attributes
+  Attributes.each{ |name|
+    module_eval <<-RUBY
+      def #{name}
+        (r = super).nil? ? (self.#{name} = self.class.default_#{name}) : r
+      end
+    RUBY
+  }
+
+  # setup defaults
+  module DefaultAttributes
+    extend self
+    def default_data        ; {}                           ; end
+    def default_auto_decode ; true                         ; end
+    def default_graph_server; 'https://graph.facebook.com/'; end
+    def default_fql_server  ; 'https://api.facebook.com/'  ; end
+    def default_accept      ; 'text/javascript'            ; end
+    def default_lang        ; 'en-us'                      ; end
+    def default_app_id      ; nil                          ; end
+    def default_secret      ; nil                          ; end
+  end
+  extend DefaultAttributes
 
+  def initialize o = {}
+    (Attributes + [:access_token]).each{ |name|
+      send("#{name}=", o[name]) if o.key?(name)
+    }
     check_arguments!
   end
 
@@ -26,10 +50,6 @@ class RestGraph < Struct.new(:data, :graph_server, :fql_server,
     data['access_token'] = token
   end
 
-  def data
-    super || self.data = {}
-  end
-
   def authorized?
     !!access_token
   end
@@ -102,7 +122,7 @@ class RestGraph < Struct.new(:data, :graph_server, :fql_server,
   def build_query_string q = {}
     query = q.merge(access_token ? {:access_token => access_token} : {})
     return '' if query.empty?
-    return '?' + query.map{ |(k, v)| "#{k}=#{CGI.escape(v)}" }.join('&')
+    return '?' + query.map{ |(k, v)| "#{k}=#{CGI.escape(v.to_s)}" }.join('&')
   end
 
   def build_headers

data/rest-graph.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rest-graph}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Cardinal Blue", "Lin Jen-Shin (aka godfat 真常)"]
+  s.date = %q{2010-05-11}
+  s.description = %q{ super simple facebook open graph api client}
+  s.email = %q{godfat (XD) cardinalblue.com}
+  s.extra_rdoc_files = ["CHANGES", "LICENSE", "README", "TODO", "bench/config.ru"]
+  s.files = ["CHANGES", "LICENSE", "README", "Rakefile", "TODO", "bench/config.ru", "init.rb", "lib/rest-graph.rb", "lib/rest-graph/load_config.rb", "lib/rest-graph/version.rb", "test/common.rb", "test/config/rest-graph.yaml", "test/test_load_config.rb", "test/test_rest-graph.rb"]
+  s.homepage = %q{http://github.com/cardinalblue/rest-graph}
+  s.rdoc_options = ["--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rest-graph}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{super simple facebook open graph api client}
+  s.test_files = ["test/test_load_config.rb", "test/test_rest-graph.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-client>, [">= 1.5.0"])
+      s.add_development_dependency(%q<json>, [">= 1.4.3"])
+      s.add_development_dependency(%q<rack>, [">= 1.1.0"])
+      s.add_development_dependency(%q<rr>, [">= 0.10.11"])
+      s.add_development_dependency(%q<webmock>, [">= 1.1.0"])
+      s.add_development_dependency(%q<bacon>, [">= 1.1.0"])
+      s.add_development_dependency(%q<bones>, [">= 3.4.1"])
+    else
+      s.add_dependency(%q<rest-client>, [">= 1.5.0"])
+      s.add_dependency(%q<json>, [">= 1.4.3"])
+      s.add_dependency(%q<rack>, [">= 1.1.0"])
+      s.add_dependency(%q<rr>, [">= 0.10.11"])
+      s.add_dependency(%q<webmock>, [">= 1.1.0"])
+      s.add_dependency(%q<bacon>, [">= 1.1.0"])
+      s.add_dependency(%q<bones>, [">= 3.4.1"])
+    end
+  else
+    s.add_dependency(%q<rest-client>, [">= 1.5.0"])
+    s.add_dependency(%q<json>, [">= 1.4.3"])
+    s.add_dependency(%q<rack>, [">= 1.1.0"])
+    s.add_dependency(%q<rr>, [">= 0.10.11"])
+    s.add_dependency(%q<webmock>, [">= 1.1.0"])
+    s.add_dependency(%q<bacon>, [">= 1.1.0"])
+    s.add_dependency(%q<bones>, [">= 3.4.1"])
+  end
+end

data/test/common.rb

@@ -0,0 +1,28 @@
+
+require 'rubygems' if RUBY_VERSION < '1.9.0'
+require 'rack'     if RUBY_VERSION < '1.9.0' # autoload broken in 1.8?
+require 'rest-graph'
+
+require 'rr'
+require 'webmock'
+require 'bacon'
+
+include RR::Adapters::RRMethods
+include WebMock
+WebMock.disable_net_connect!
+Bacon.summary_on_exit
+
+module TestHelper
+  module_function
+  def ensure_rollback
+    yield
+
+  ensure # the defaults should remain the same!
+    RestGraph.send(:extend, RestGraph::DefaultAttributes.dup)
+
+    RestGraph::Attributes.each{ |name|
+      RestGraph.new.send(name).should ==
+        RestGraph::DefaultAttributes.send("default_#{name}")
+    }
+  end
+end

data/test/config/rest-graph.yaml

@@ -0,0 +1,6 @@
+
+test:
+  app_id: 41829
+  secret: <%= 'r41829'.reverse %>
+  auto_decode: false
+  lang: zh-tw

data/test/test_load_config.rb

@@ -0,0 +1,36 @@
+
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
+
+require 'rest-graph/load_config'
+
+describe RestGraph::LoadConfig do
+
+  it 'would honor rails config' do
+    ::Rails = Object.new
+    mock(Rails).env { 'test' }
+    mock(Rails).root{ File.dirname(__FILE__) }
+
+    check = lambda{
+      RestGraph.default_app_id.should ==   41829
+      RestGraph.default_secret.should == 'r41829'.reverse
+      RestGraph.default_auto_decode.should == false
+      RestGraph.default_lang.should        == 'zh-tw'
+    }
+
+    TestHelper.ensure_rollback{
+      RestGraph::LoadConfig.load_if_rails!
+      check
+    }
+
+    TestHelper.ensure_rollback{
+      RestGraph::LoadConfig.load_config!(
+        "#{File.dirname(__FILE__)}/config/rest-graph.yaml",
+        'test')
+      check
+    }
+  end
+end

data/test/test_rest-graph.rb

@@ -1,16 +1,9 @@
 
-require 'rubygems' if RUBY_VERSION < '1.9.0'
-require 'rack'     if RUBY_VERSION < '1.9.0' # autoload broken in 1.8?
-require 'rest-graph'
-
-require 'rr'
-require 'webmock'
-require 'bacon'
-
-include RR::Adapters::RRMethods
-include WebMock
-WebMock.disable_net_connect!
-Bacon.summary_on_exit
+if respond_to?(:require_relative, true)
+  require_relative 'common'
+else
+  require File.dirname(__FILE__) + '/common'
+end
 
 describe RestGraph do
   before do
@@ -156,4 +149,34 @@ describe RestGraph do
 
     RestGraph.new(:access_token => token).fql(fql).should == []
   end
+
+  it 'would honor default attributes' do
+    RestGraph::Attributes.each{ |name|
+      RestGraph.new.send(name).should ==
+        RestGraph.send("default_#{name}")
+
+      RestGraph.new.send(name).should ==
+        RestGraph::DefaultAttributes.send("default_#{name}")
+    }
+  end
+
+  it 'would convert query to string' do
+    mock(o = Object.new).to_s{ 'i am mock' }
+    stub_request(:get, "https://graph.facebook.com/search?q=i%20am%20mock").
+      to_return(:body => 'ok')
+    RestGraph.new(:auto_decode => false).get('search', :q => o).should == 'ok'
+  end
+
+  it 'could use module to override default attributes' do
+    module BlahAttributes
+      def default_app_id
+        '1829'
+      end
+    end
+
+    TestHelper.ensure_rollback{
+      RestGraph.send(:extend, BlahAttributes)
+      RestGraph.default_app_id.should == '1829'
+    }
+  end
 end

metadata

@@ -4,17 +4,18 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
+- Cardinal Blue
 - "Lin Jen-Shin (aka godfat \xE7\x9C\x9F\xE5\xB8\xB8)"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-05-06 00:00:00 +08:00
+date: 2010-05-13 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -116,7 +117,7 @@ dependencies:
   type: :development
   version_requirements: *id007
 description: " super simple facebook open graph api client"
-email: godfat (XD) godfat.org
+email: dev (XD) cardinalblue.com
 executables: []
 
 extensions: []
@@ -124,26 +125,32 @@ extensions: []
 extra_rdoc_files: 
 - CHANGES
 - LICENSE
-- README
 - TODO
+- rest-graph.gemspec
 files: 
 - CHANGES
 - LICENSE
-- README
+- README.rdoc
 - Rakefile
 - TODO
 - init.rb
 - lib/rest-graph.rb
+- lib/rest-graph/auto_load.rb
+- lib/rest-graph/load_config.rb
 - lib/rest-graph/version.rb
+- rest-graph.gemspec
+- test/common.rb
+- test/config/rest-graph.yaml
+- test/test_load_config.rb
 - test/test_rest-graph.rb
 has_rdoc: true
-homepage: http://github.com/godfat/rest-graph
+homepage: http://github.com/cardinalblue/rest-graph
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -168,4 +175,5 @@ signing_key:
 specification_version: 3
 summary: super simple facebook open graph api client
 test_files: 
+- test/test_load_config.rb
 - test/test_rest-graph.rb