rest-graph 0.8.0

data/CHANGES

@@ -0,0 +1,4 @@
+= rest-graph changes history
+
+== rest-graph 0.8.0 -- 2010-05-03
+* release early, release often

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README

@@ -0,0 +1,51 @@
+= rest-graph 0.8.0
+by Lin Jen-Shin (aka godfat-真常[http://godfat.org])
+  godfat (XD) godfat.org
+
+== LINKS:
+
+* {github}[http://github.com/godfat/rest-graph]
+* {rubygems}[http://rubygems.org/gems/rest-graph]
+* {rdoc}[http://rdoc.info/projects/godfat/rest-graph]
+
+== DESCRIPTION:
+
+ super simple facebook open graph api client
+
+== SYNOPSIS:
+
+ require 'rest-graph'
+ rg = RestGraph.new(:access_token => '...')
+ rg.get('me')
+ rg.post('feed/me', :message => 'bread!')
+
+== REQUIREMENTS:
+
+* tested with MRI 1.8.7 and 1.9.1
+* gem install rest-client
+* gem install json (optional)
+* gem install json_pure (optional)
+
+== INSTALL:
+
+ > gem install rest-graph
+ # or if you want rails plugin and bleeding edge
+ > script/plugin install git://github.com/godfat/rest-graph.git
+
+== LICENSE:
+
+  Apache License 2.0
+
+  Copyright (c) 2010, Lin Jen-Shin (aka godfat 真常)
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+begin
+  require 'bones'
+rescue LoadError
+  abort '### Please install the "bones" gem ###'
+end
+
+ensure_in_path 'lib'
+proj = 'rest-graph'
+require "#{proj}/version"
+
+Bones{
+  ruby_opts [''] # silence warning for now
+
+  version RestGraph::VERSION
+
+  depend_on 'rest-client'
+  depend_on 'json',    :development => true
+
+  depend_on 'rr',      :development => true
+  depend_on 'webmock', :development => true
+  depend_on 'bacon',   :development => true
+
+  name    proj
+  url     "http://github.com/godfat/#{proj}"
+  authors 'Lin Jen-Shin (aka godfat 真常)'
+  email   'godfat (XD) godfat.org'
+
+  history_file   'CHANGES'
+   readme_file   'README'
+   ignore_file   '.gitignore'
+  rdoc.include   ['\w+']
+  rdoc.exclude   ['test', 'doc', 'Rakefile']
+}
+
+CLEAN.include Dir['**/*.rbc']
+
+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/TODO

@@ -0,0 +1,3 @@
+= rest-graph todo list
+
+= ?

data/init.rb

@@ -0,0 +1 @@
+require 'rest-graph'

data/lib/rest-graph.rb

@@ -0,0 +1,69 @@
+
+require 'rest_client'
+
+require 'cgi'
+
+class RestGraph
+  attr_accessor :access_token, :server, :accept, :lang, :auto_decode
+  def initialize o = {}
+    self.access_token = o[:access_token]
+    self.server       = o[:server] || 'https://graph.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
+
+    if auto_decode
+      begin
+        require 'json'
+      rescue LoadError
+        require 'json_pure'
+      end
+    end
+  end
+
+  def client
+    @client ||= RestClient::Resource.new(server)
+  end
+
+  def get    path, query = {}
+    request(path, query, :get)
+  end
+
+  def delete path, query = {}
+    request(path, query, :delete)
+  end
+
+  def post   path, payload, query = {}
+    request(path, query, :post, payload)
+  end
+
+  def put    path, payload, query = {}
+    request(path, query, :put,  payload)
+  end
+
+  private
+  def request path, query, method, payload = nil
+    post_request(
+      client[path + build_query_string(query)].
+        send(method, *[payload, build_headers].compact))
+  rescue RestClient::InternalServerError => e
+    post_request(e.http_body)
+  end
+
+  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('&')
+  end
+
+  def build_headers
+    headers = {}
+    headers['Accept']          = accept if accept
+    headers['Accept-Language'] = lang   if lang
+    headers
+  end
+
+  def post_request result
+    auto_decode ? JSON.parse(result) : result
+  end
+end

data/lib/rest-graph/version.rb

@@ -0,0 +1,4 @@
+
+class RestGraph
+  VERSION = '0.8.0'
+end

data/test/test_rest-graph.rb

@@ -0,0 +1,105 @@
+
+require 'rubygems' if RUBY_VERSION < '1.9.0'
+require 'rest-graph'
+
+require 'rr'
+require 'webmock'
+require 'bacon'
+
+include RR::Adapters::RRMethods
+include WebMock
+WebMock.disable_net_connect!
+Bacon.summary_on_exit
+
+describe RestGraph do
+  before do
+    reset_webmock
+  end
+
+  def normalize_query query
+    '?' + query[1..-1].split('&').sort.join('&')
+  end
+
+  it 'would build correct headers' do
+    rg = RestGraph.new(:accept => 'text/html',
+                       :lang   => 'zh-tw')
+    rg.send(:build_headers).should == {'Accept'          => 'text/html',
+                                       'Accept-Language' => 'zh-tw'}
+  end
+
+  it 'would build empty query string' do
+    RestGraph.new.send(:build_query_string).should == ''
+  end
+
+  it 'would create access_token in query string' do
+    RestGraph.new(:access_token => 'token').send(:build_query_string).
+      should == '?access_token=token'
+  end
+
+  it 'would build correct query string' do
+    normalize_query(
+    RestGraph.new(:access_token => 'token').send(:build_query_string,
+                                                 :message => 'hi!!')).
+      should == '?access_token=token&message=hi%21%21'
+
+    normalize_query(
+    RestGraph.new.send(:build_query_string, :message => 'hi!!',
+                                            :subject => '(&oh&)')).
+      should == '?message=hi%21%21&subject=%28%26oh%26%29'
+  end
+
+  it 'would request to correct server' do
+    stub_request(:get, 'http://nothing.godfat.org/me').with(
+      :headers => {'Accept'          => 'text/plain',
+                   'Accept-Language' => 'zh-tw',
+                   'Accept-Encoding' => 'gzip, deflate', # this is by ruby
+                  }.merge(RUBY_VERSION <= '1.9.0' ?
+                  {} :
+                  {'User-Agent'      => 'Ruby'})).       # this is by ruby
+      to_return(:body => '{"data": []}')
+
+    RestGraph.new(:server => 'http://nothing.godfat.org',
+                  :lang   => 'zh-tw',
+                  :accept => 'text/plain').get('me').should == {'data' => []}
+  end
+
+  it 'would post right' do
+    stub_request(:post, 'https://graph.facebook.com/feed/me').
+      with(:body => 'message=hi%20there').to_return(:body => 'ok')
+
+    RestGraph.new(:auto_decode => false).
+      post('feed/me', :message => 'hi there').should == 'ok'
+  end
+
+  it 'would auto decode json' do
+    RestGraph.new(:auto_decode => true).send(:post_request, '[]').
+      should == []
+  end
+
+  it 'would not auto decode json' do
+    RestGraph.new(:auto_decode => false).send(:post_request, '[]').
+      should == '[]'
+  end
+
+  it 'would call post_request after request' do
+    stub_request(:put, 'https://graph.facebook.com/feed/me').
+      with(:body => 'message=hi%20there').to_return(:body => '[]')
+
+    begin
+      RestGraph.send(:public, :post_request) # TODO: rr, why??
+
+      mock.proxy(rg = RestGraph.new).post_request('[]')
+      rg.put('feed/me', :message => 'hi there').
+        should == []
+    ensure
+      RestGraph.send(:private, :post_request) # TODO: rr, why??
+    end
+  end
+
+  it 'would not raise exception when encountering 500' do
+    stub_request(:delete, 'https://graph.facebook.com/123').to_return(
+      :body => '[]', :status => 500)
+
+    RestGraph.new.delete('123').should == []
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: rest-graph
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
+platform: ruby
+authors: 
+- "Lin Jen-Shin (aka godfat \xE7\x9C\x9F\xE5\xB8\xB8)"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-03 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 11
+        version: 0.10.11
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bones
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 4
+        - 1
+        version: 3.4.1
+  type: :development
+  version_requirements: *id006
+description: " super simple facebook open graph api client"
+email: godfat (XD) godfat.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGES
+- LICENSE
+- README
+- TODO
+files: 
+- CHANGES
+- LICENSE
+- README
+- Rakefile
+- TODO
+- init.rb
+- lib/rest-graph.rb
+- lib/rest-graph/version.rb
+- test/test_rest-graph.rb
+has_rdoc: true
+homepage: http://github.com/godfat/rest-graph
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rest-graph
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: super simple facebook open graph api client
+test_files: 
+- test/test_rest-graph.rb