meta_graph 0.0.2

data/.gitignore

@@ -0,0 +1,9 @@
+.rspec
+.bundle/
+
+bundle/
+doc/
+
+Gemfile.lock
+
+meta_graph-*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+# MetaGraph
+
+MetaGraph is a lightweight client of Facebook Graph API.

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/meta_graph.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'httpclient'
+require 'json'
+
+require 'meta_graph/hash_accessor'
+require 'meta_graph/graph_accessor'
+require 'meta_graph/client'
+require 'meta_graph/resource'
+require 'meta_graph/node'
+require 'meta_graph/collection'
+
+module MetaGraph
+  #
+  # GraphAPI based URL
+  #
+  GRAPH_API_END_POINT = 'https://graph.facebook.com/'
+end

data/lib/meta_graph/client.rb

@@ -0,0 +1,46 @@
+module MetaGraph
+  #
+  # Graph API Client class.
+  #
+  # To get a user data, photo data, album data, and so on from Facebook's
+  # Graph API. First, create this client and call the _get_ method, then
+  # you can get a instance of Node class.
+  #
+  class Client
+    attr_reader :access_token
+
+    #
+    # Create and initialize Graph API Client.
+    #
+    # === Argument
+    # [access_token] access token to read a data from Graph API.
+    #                Please set to oauth's access_token.
+    #
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    #
+    # Get a data from Graph API.
+    #
+    # === Argument
+    # [path] ID you want or full URL.
+    #
+    def fetch(path)
+      resource = Resource.new(@access_token, path.to_s)
+
+      if resource.data && resource.data.is_a?(Array)
+        Collection.new(@access_token, resource.data)
+      else
+        Node.new(@access_token, resource)
+      end
+    end
+
+    #
+    # Get a your *User* data from Graph API. It equals to fetch('me').
+    #
+    def me
+      fetch(:me)
+    end
+  end
+end

data/lib/meta_graph/collection.rb

@@ -0,0 +1,27 @@
+module MetaGraph
+  #
+  # *Collection* class presents an array data in Facebook Graph API.
+  #
+  class Collection < Array
+    include GraphAccessor
+
+    #
+    # Create *Collection* instance from an array.
+    #
+    # === Arguments
+    # [access_token] access token to read a data from Graph API.
+    #                Please set to oauth's access_token.
+    # [collection]   An array of collection data.
+    #
+    def initialize(access_token, collection)
+      @access_token = access_token
+      @collection = collection
+
+      replace @collection
+    end
+
+    def [](index)
+      read_graph(@access_token, @collection[index])
+    end
+  end
+end

data/lib/meta_graph/graph_accessor.rb

@@ -0,0 +1,13 @@
+module MetaGraph
+  module GraphAccessor
+    def read_graph(access_token, data)
+      if data.is_a?(Array)
+        Collection.new(access_token, data)
+      elsif data.is_a?(Hash)
+        Node.new(access_token, data)
+      else
+        data
+      end
+    end
+  end
+end

data/lib/meta_graph/hash_accessor.rb

@@ -0,0 +1,55 @@
+module MetaGraph
+  #
+  # HashAccessor module provide a function that read value from hash as method.
+  # If this module is included on your class and specify a member variables symbol to
+  # *hash_accessor* class macro, you can get methods named hash's key and call it,
+  # then they will return hash's value.
+  #
+  module HashAccessor
+    #
+    # When this module is included on your class, it adds *hash_accessor* class macro to
+    # included class.
+    #
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    #
+    # mixins
+    #
+    module ClassMethods
+      #
+      # Specified your class member variable hash value in this method is to access as the
+      # method.
+      #
+      def hash_accessor(hash_name)
+        @hash_name = hash_name
+      end
+    end
+
+    #
+    # Read a hash value by specifing has key. Reading hash value In this method is
+    # the hash that specified in _hash_accessor_ class macro.
+    #
+    # === Argument
+    # [key] specify hash key
+    #
+    def read_hash(key)
+      hash_name = self.class.instance_variable_get('@hash_name')
+      hash = instance_variable_get("@#{hash_name}")
+
+      hash[key] if hash.key?(key)
+    end
+
+    #
+    # If the hash that specified to _hash_accessor_ class macro has a key same as 
+    # the called method name, get the hash value.
+    #
+    def method_missing(method, *args, &block)
+      value = read_hash(method) || read_hash(method.to_s)
+      return value if value
+
+      super(method, *args, &block)
+    end
+  end
+end

data/lib/meta_graph/node.rb

@@ -0,0 +1,116 @@
+module MetaGraph
+  #
+  # Node class presents Facebook object which is *User*, *Photo*,
+  # *Album*, *Comment*, and so on.
+  #
+  class Node
+    include HashAccessor, GraphAccessor
+
+    hash_accessor :fields
+
+    #
+    # Create Node instance from a object that read in *Resource* class
+    # instance. Through this class, you can read every fields in a object
+    # by accessing to field name such like _obj.id_, _obj.username_.
+    #
+    # === Arguments
+    # [access_token] access token to read a data from Graph API.
+    #                Please set to oauth's access_token.
+    # [resource]     Set *Resource* class instance or hash value. If *Resource*
+    #                class instance is set in this argument, _fields_ and
+    #                _connections_ in this instance are constructed from resource.
+    #                If hash value is set, then it is set to _fields_
+    #                variable in this instance.
+    #
+    def initialize(access_token, resource)
+      @access_token = access_token
+
+      if resource.is_a?(Resource)
+        @resource = resource
+        @fields = resource.fields
+        @connections = resource.connections
+      else
+        @fields = resource
+        @connections = {}
+      end
+    end
+
+    #
+    # Get ID of this object. Return nil if this object has no id.
+    #
+    def id
+      return @fields[:id] if @fields.key?(:id)
+    end
+
+    #
+    # Get connection data as an array. Return nil if this ojbect
+    # doesn't have connection specified in _name_ argument.
+    #
+    # === Argument
+    # [name] connection name.
+    #
+    def connection(name)
+      if @connections.key?(name)
+        res = Resource.new(@access_token, @connections[name])
+        return Collection.new(@access_token, res.data)
+      end
+    end
+
+    #
+    # Check if this object's resource is loaded.
+    #
+    def load_resource?
+      !@resource.nil?
+    end
+
+    #
+    # Load this object's resource from Facebook Graph API and
+    # return it. If resource already has loaded or there is no 
+    # object id, this method do nothing.
+    # 
+    def load_resource
+      if id && !load_resource?
+        @resource = Resource.new(@access_token, id)
+        @fields = @resource.fields
+        @connections = @resource.connections
+      end
+
+      return @resource
+    end
+
+    #
+    # Read a field value or connection data. Return nil if you
+    # set not exist key name to _key_ argument.
+    #
+    # === Argument
+    # [key] field name or connection name you want to read
+    #
+    def read(key)
+      con = connection(key)
+      return con if con
+
+      value = read_hash(key)
+      return read_graph(@access_token, value) if value
+    end
+
+    #
+    # You can access object fields as calling method. When this object
+    # has _id_, _name_, _link_, etc, you can access these fields like
+    # _object.id_, _object.name_, _object.link_.
+    #
+    # In addition, if the object has connections, you can access connections
+    # as well, then *GraphCollection* instance is returned.
+    #
+    def method_missing(method, *args, &block)
+      data = read(method)
+      return data if data
+
+      if !load_resource.nil?
+        data = read(method)
+        return data if data
+      end
+
+      super(method, *args, &block)
+    end
+  end
+end

data/lib/meta_graph/resource.rb

@@ -0,0 +1,90 @@
+module MetaGraph
+  #
+  # Resource module provide a function that read a data from Graph API.
+  #
+  class Resource
+    attr_reader :access_token, :api_result
+
+    #
+    # Get the HTTP-Client instance to read a data from Graph API.
+    #
+    def self.http_client
+      @http_client ||= HTTPClient.new(:agent_name => 'MetaGraph')
+      @http_client
+    end
+
+    #
+    # Read a data from Graph API and create Resource class instance.
+    #
+    # About arguments, Please see at _read_ method's description. _initialize_
+    # method arguments are same to _read_ method.
+    #
+    def initialize(access_token, path)
+      @access_token = access_token
+      @api_raw_result = read(@access_token, path)
+      @api_result = JSON.parse(@api_raw_result, :symbolize_names => true)
+      @metadata = @api_result.delete(:metadata)
+    end
+
+    #
+    # read an object specified id from Graph API.
+    #
+    # === Arguments
+    # [path]         Graph API path you want.
+    #                For example, when you specified '*me*' to this arg, this module
+    #                read your *User* object from Graph API.
+    #                Otherwise, when full api url is specified, you will get data
+    #                from that url.
+    # [access_token] access token to read a data from Graph API.
+    #                Please set to oauth's access_token.
+    #
+    def read(access_token, path)
+      path = GRAPH_API_END_POINT + path.to_s unless path.index(GRAPH_API_END_POINT)
+      params = {
+        :access_token => access_token,
+        :metadata => 1
+      }
+
+      Resource.http_client.get(path, params).body
+    end
+
+    #
+    # Get the metadata in Graph API result set. Return empty hash if result
+    # set don't contain the metadata.
+    #
+    def metadata
+      @metadata || {}
+    end
+
+    #
+    # Get a hash that has a key named field name.
+    #
+    def fields
+      fields = {}
+      @api_result.each do |key, value|
+        fields[key.to_sym] = value
+      end
+      fields
+    end
+
+    #
+    # Get a collection data
+    #
+    def data
+      return @api_result[:data] if @api_result.key?(:data)
+    end
+
+    #
+    # Get an array of connections that has a key named connection name.
+    #
+    def connections
+      connections = {}
+      if metadata.key?(:connections)
+        metadata[:connections].each do |connection, url|
+          connections[connection.to_sym] = url
+        end
+      end
+      connections
+    end
+  end
+end

data/meta_graph.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'meta_graph'
+  s.version     = File.read('VERSION').delete("\n\r")
+  s.summary     = 'Meta Graph'
+  s.description = 'A lightweight client of Facebook Graph API'
+  s.authors     = [ 'Kengo Tateishi' ]
+  s.email       = 'embrace.ddd.flake.peace@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {spec}/*`.split("\n")
+  s.homepage    = 'https://github.com/tkengo/meta_graph'
+
+  s.add_runtime_dependency 'httpclient'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+end

data/spec/json/116314101712416.json

@@ -0,0 +1,12 @@
+{
+  "description": ", is a 1988 Japanese animated fantasy film written and directed by Hayao Miyazaki and produced by Studio Ghibli. The film follows the two young daughters of a professor and their interactions with friendly wood spirits in postwar rural Japan. The film won the Animage Anime Grand Prix prize and the Mainichi Film Award for Best Film in 1988.The film was released on VHS and laserdisc in the United States by Tokuma Japan Communications' US subsidiary in 1993 with the title My Friend Totoro.In 1988, Streamline Pictures produced an exclusive dub for use on transpacific flights by Japan Airlines and its Oneworld partners. Troma Films, under their 50th St. Films banner, distributed the dub of the film co-produced by Jerry Beck. It was released on VHS and DVD by Fox Video. Troma's and Fox's rights to this version expired in 2004. The film was re-released by Disney on March 7, 2006. and by Madman on March 15, 2006. It features a new dub cast. This DVD release is the first version of the film in the United States to include both Japanese and English language tracks, as Fox did not have the rights to the Japanese audio track for their version.", 
+  "is_community_page": true, 
+  "is_published": true, 
+  "talking_about_count": 9, 
+  "were_here_count": 0, 
+  "category": "Movie", 
+  "id": "116314101712416", 
+  "name": "となりのトトロ", 
+  "link": "https://www.facebook.com/pages/%E3%81%A8%E3%81%AA%E3%82%8A%E3%81%AE%E3%83%88%E3%83%88%E3%83%AD/116314101712416", 
+  "likes": 5607
+}

data/spec/json/125808504153906.json

@@ -0,0 +1,11 @@
+{
+  "is_community_page": true, 
+  "is_published": true, 
+  "talking_about_count": 10, 
+  "were_here_count": 0, 
+  "category": "City", 
+  "id": "125808504153906", 
+  "name": "Tosu-shi, Saga, Japan", 
+  "link": "https://www.facebook.com/pages/Tosu-shi-Saga-Japan/125808504153906", 
+  "likes": 536
+}

data/spec/json/164489816910252.json

@@ -0,0 +1,30 @@
+{
+  "about": "私たちpaperboy&co.（ペーパーボーイアンドコー）は、「もっとおもしろくできる」を理念として、すべての企業活動において、他社よりもおもしろいものを目指します。", 
+  "can_post": true, 
+  "company_overview": "【世の中をもっとおもしろく、そしてワクワクさせるインターネットサービス！】\n\npaperboy&co.（ペパボ）は、インターネットを使った自己表現やコミュニケーションを支えるクリエイター集団です。ブログやサーバー、電子書籍の作成、販売支援など、多数のインターネットサービスをリーズナブルかつ使いやすく、楽しい機能を取り入れて提供しています。 \n\n", 
+  "founded": "2003年1月10日", 
+  "is_published": true, 
+  "location": {
+    "street": "桜丘町26-1", 
+    "city": "Shibuya-ku", 
+    "state": "Tokyo", 
+    "country": "Japan", 
+    "zip": "1508512"
+  }, 
+  "mission": "『より多くの人に情報発信する喜びを提供する』\n\npaperboy&co.が提供しているサービスのターゲットは自己表現をしたい個人の方です。インターネットを活用した自己表現や情報発信を支援するためのサービスを「低価格で使いやすく」提供することで、より多くの人に情報発信することの喜びを感じて欲しいと願っています。\n\n", 
+  "products": "★サーバーホスティング、ドメインサービス\nロリポップ！ http://lolipop.jp/\nheteml（ヘテムル） http://heteml.jp/\nムームードメイン http://muumuu-domain.com/\nSqale（スケール）http://sqale.jp/\n\n★ショッピング、EC支援サービス\nカラーミーショップ http://shop-pro.jp/\nカラメル http://calamel.jp/\nminne（ミンネ） http://minne.com/\nECフォト http://ec-photo.jp/\n\n★コミュニティサービス\nJUGEM http://jugem.jp/\nGrouptube http://grouptube.jp/\nログピ http://logpi.jp/\nザ・インタビューズ http://theinterviews.jp/\n\n★写真、ホームページ作成、音楽配信サービス\nプチ・ホームページサービス http://petit.cc/\n30days Album（サーティーデイズ アルバム） http://30d.jp/\nGoope（グーペ） http://goope.jp/\nFANIC（ファニック） http://fanic.jp/\n\n\n★電子書籍関連サービス\nブクログ http://booklog.jp/\nパブー http://p.booklog.jp/\n\n\n★ネットのおサイフとギフトサービス\nおさいぽ！ http://osaipo.jp/\nギフポ http://gifpo.jp/", 
+  "talking_about_count": 22, 
+  "username": "PEPABO", 
+  "website": "http://www.paperboy.co.jp/", 
+  "were_here_count": 0, 
+  "category": "Internet/software", 
+  "id": "164489816910252", 
+  "name": "Paperboy&co.", 
+  "link": "https://www.facebook.com/PEPABO", 
+  "likes": 9731, 
+  "cover": {
+    "cover_id": 551075911584972, 
+    "source": "https://fbcdn-sphotos-b-a.akamaihd.net/hphotos-ak-snc7/s720x720/299425_551075911584972_537694850_n.jpg", 
+    "offset_y": 0
+  }
+}