fb_graph2 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c8a159c7d77db9a3e0dc1c216b48af33b13607b
-  data.tar.gz: cd9d38bc8c9d472dbb2bdd46066a564b63cb1e68
+  metadata.gz: 37cb2d2c7a4656ed062f89cdd23f62c4d3330b75
+  data.tar.gz: e7245ddeb28a753a0c0a944090d9c2405bc91362
 SHA512:
-  metadata.gz: 88849dbc9b87d5686b0c9aef2958e0a30fd796350d1d079c9bb44da9b55eee6b551dcc80b1c3de82001106cfcb3ca518425a8daa8f323d529b1e01c1ab0f0c3a
-  data.tar.gz: 65dfae68dd22c6e6308c7df7e409bc42d2d6ee08ef556ca615593fab9de008441417a0cac46a7753c1ef74981f25e13e711d5ff46ed28d48baea2360ba54a6c7
+  metadata.gz: e9ffa26d19e497c0c528ef45a9b9d5745d1a0762d102d25a37080226a9d9d9f0eaf5b15a4b917335342927a5fc11b9ce22f5967b981ef3d202873e12a6a6cceb
+  data.tar.gz: 086e24af8d48fd1e0857cdbf55e1aec2b701c57cc176530952be8bc49ea491d20bd56f7640ebbd128185dc4e0a40bd7a693525177e0e3658fdef1151ecf58030

data/.travis.yml

@@ -0,0 +1,3 @@
+rvm:
+  - 2.0.0
+  - 2.1.2

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/fb_graph2/app_link_host.rb

@@ -25,8 +25,6 @@ module FbGraph2
           Struct::AppLink::Native::Android
         when :windows_phone
           Struct::AppLink::Native::WindowsPhone
-        else
-          raise 'Unknown AppLink Type'
         end
         klass.new link
       end

data/lib/fb_graph2/attribute_assigner.rb

@@ -24,6 +24,8 @@ module FbGraph2
             value = case type
             when :raw
               raw
+            when :int_flag
+              raw == 1
             when :date
               Date.strptime raw, '%m/%d/%Y' rescue raw
             when :time

data/lib/fb_graph2/auth.rb

@@ -0,0 +1,13 @@
+module FbGraph2
+  class Auth < Rack::OAuth2::Client
+    def initialize(client_id, client_secret, options = {})
+      super options.merge(
+        identifier: client_id,
+        secret: client_secret,
+        host: URI.parse(FbGraph2.root_url).host,
+        authorize_endpoint: '/oauth/authorize',
+        token_endpoint: '/oauth/access_token'
+      )
+    end
+  end
+end

data/lib/fb_graph2/exception.rb

@@ -0,0 +1,81 @@
+module FbGraph2
+  class Exception < StandardError
+    attr_accessor :status, :type, :code
+
+    class << self
+      def detect(status, body = {}, headers = {})
+        error = body[:error]
+        message = error.try(:[], :message)
+        klass = detect_from_header(headers, error) || detect_from_status(status)
+        if klass
+          klass.new message, error
+        else
+          new status, message, error
+        end
+      end
+
+      def detect_from_status(status)
+        case status
+        when 400
+          BadRequest
+        when 401
+          Unauthorized
+        when 404
+          NotFound
+        when 500
+          InternalServerError
+        end
+      end
+
+      def detect_from_header(headers, error)
+        key, value = headers.detect do |name, value|
+          name.upcase == "WWW-Authenticate".upcase
+        end || return
+        matched, klass = ERROR_HEADER_MATCHERS.detect do |matcher, klass_name|
+          matcher =~ value
+        end || return
+        klass
+      end
+    end
+
+    def initialize(status, message, error = {})
+      super message
+      self.status = status
+      self.type = error[:type]
+      self.code = error[:code]
+    end
+
+    class BadRequest < Exception
+      def initialize(message, details = {})
+        super 400, message, details
+      end
+    end
+
+    class Unauthorized < Exception
+      def initialize(message, details = {})
+        super 401, message, details
+      end
+    end
+
+    class NotFound < Exception
+      def initialize(message, details = {})
+        super 404, message, details
+      end
+    end
+
+    class InternalServerError < Exception
+      def initialize(message, details = {})
+        super 500, message, details
+      end
+    end
+
+    class InvalidToken < Unauthorized; end
+    class InvalidRequest < BadRequest; end
+
+    ERROR_HEADER_MATCHERS = {
+      /not_found/       => NotFound,
+      /invalid_token/   => InvalidToken,
+      /invalid_request/ => InvalidRequest
+    }
+  end
+end

data/lib/fb_graph2/node.rb

@@ -18,13 +18,13 @@ module FbGraph2
       self
     end
 
-    def fetch(params = {})
-      attributes = get params
+    def fetch(params = {}, options = {})
+      attributes = get params, options
       self.class.new(attributes[:id], attributes).authenticate access_token
     end
 
-    def self.fetch(identifier, params = {})
-      new(identifier).fetch params
+    def self.fetch(identifier, params = {}, options = {})
+      new(identifier).fetch params, options
     end
 
     def edge(edge, params = {}, options = {})
@@ -85,7 +85,11 @@ module FbGraph2
 
     def build_endpoint(options = {})
       File.join [
-        File.join(FbGraph2.root_url, id.to_s),
+        File.join(
+          FbGraph2.root_url,
+          options[:api_version] || FbGraph2.api_version,
+          id.to_s
+        ),
         options[:edge],
         Util.as_identifier(options[:edge_scope])
       ].compact.collect(&:to_s)
@@ -103,12 +107,10 @@ module FbGraph2
       when 200...300
         _response_
       else
-        # TODO: better exception structure
-        raise response.body
+        raise Exception.detect(response.status, _response_, response.headers)
       end
     rescue MultiJson::DecodeError
-      # TODO: better exception structure
-      raise response.body
+      raise Exception.new(response.status, "Unparsable Response: #{response.body}")
     end
   end
 end

data/lib/fb_graph2/page.rb

@@ -21,19 +21,28 @@ module FbGraph2
     register_attributes(
       raw: [
         :about, :attire, :band_members, :booking_agent, :can_post, :category, :checkins, :company_overview,
-        :current_location, :description, :directed_by, :founded, :general_info, :general_manager, :hometown,
+        :current_location, :description, :directed_by, :founded, :general_info, :general_manager, :hometown, :hours,
         :is_permanently_closed, :is_published, :is_unclaimed, :likes, :link, :mission, :name, :phone, :press_contact,
-        :products, :talking_about_count, :username, :website, :were_here_count,
+        :price_range, :products, :talking_about_count, :username, :website, :were_here_count,
         # NOTE: only within /:user_id/accounts context
         :perms
       ],
-      time: [:created_time],
+      time: [
+        :created_time,
+        # NOTE: only as Struct::Work#start_date
+        :start_date, :end_date
+      ],
       date: [:birthday],
       page: [:best_page],
       photo: [:cover],
+      users: [
+        # NOTE: only as Struct::Work#projects
+        :with
+      ],
       custom: [
-        :category_list, :context, :hours, :location, :parking, :price_range, :restaurant_services,
-        :restaurant_specialties
+        :category_list, :context, :location, :parking, :restaurant_services, :restaurant_specialties,
+        # NOTE: undocumented
+        :payment_options
       ]
     )
 
@@ -44,7 +53,24 @@ module FbGraph2
           PageCategory.new page_category[:id], page_category
         end
       end
-      # TODO: handle other custom attributes.
+      if attributes.include? :context
+        self.context = Struct::Context::PageContext.new attributes[:context]
+      end
+      if attributes.include? :location
+        self.location = Struct::Location.new attributes[:location]
+      end
+      if attributes.include? :parking
+        self.parking = Struct::Parking.new attributes[:parking]
+      end
+      if attributes.include? :restaurant_services
+        self.restaurant_services = Struct::RestaurantServices.new attributes[:restaurant_services]
+      end
+      if attributes.include? :restaurant_specialties
+        self.restaurant_specialties = Struct::RestaurantSpecialties.new attributes[:restaurant_specialties]
+      end
+      if attributes.include? :payment_options
+        self.payment_options = Struct::PaymentOptions.new attributes[:payment_options]
+      end
     end
   end
 end

data/lib/fb_graph2/struct/age_range.rb

@@ -0,0 +1,9 @@
+module FbGraph2
+  class Struct
+    class AgeRange < Struct
+      register_attributes(
+        raw: [:min, :max]
+      )
+    end
+  end
+end

data/lib/fb_graph2/struct/context.rb

@@ -0,0 +1,18 @@
+module FbGraph2
+  class Struct
+    module Context
+      class UserContext < Struct
+        register_attributes(
+          users: [:mutual_friends],
+          pages: [:mutual_likes]
+        )
+      end
+
+      class PageContext < Struct
+        register_attributes(
+          users: [:friends_who_like, :friends_tagged_at, :music_listen_friends, :video_watch_friends]
+        )
+      end
+    end
+  end
+end

data/lib/fb_graph2/struct/currency.rb

@@ -0,0 +1,9 @@
+module FbGraph2
+  class Struct
+    class Currency < Struct
+      register_attributes(
+        raw: [:user_currency, :currency_exchange, :currency_exchange_inverse, :usd_exchange, :usd_exchange_inverse, :currency_offset]
+      )
+    end
+  end
+end

data/lib/fb_graph2/struct/education.rb

@@ -0,0 +1,11 @@
+module FbGraph2
+  class Struct
+    class Education < Struct
+      register_attributes(
+        raw: [:type],
+        page: [:school, :year],
+        pages: [:concentration]
+      )
+    end
+  end
+end

data/lib/fb_graph2/struct/location.rb

@@ -0,0 +1,9 @@
+module FbGraph2
+  class Struct
+    class Location < Struct
+      register_attributes(
+        raw: [:country, :city, :longitude, :zip, :state, :street, :located_in, :latitude]
+      )
+    end
+  end
+end

data/lib/fb_graph2/struct/parking.rb

@@ -0,0 +1,9 @@
+module FbGraph2
+  class Struct
+    class Parking < Struct
+      register_attributes(
+        int_flag: [:street, :lot, :valet]
+      )
+    end
+  end
+end

data/lib/fb_graph2/struct/payment_options.rb

@@ -0,0 +1,9 @@
+module FbGraph2
+  class Struct
+    class PaymentOptions < Struct
+      register_attributes(
+        int_flag: [:amex, :cash_only, :discover, :mastercard, :visa]
+      )
+    end
+  end
+end

data/lib/fb_graph2/struct/restaurant_services.rb

@@ -0,0 +1,9 @@
+module FbGraph2
+  class Struct
+    class RestaurantServices < Struct
+      register_attributes(
+        int_flag: [:kids, :delivery, :walkins, :catering, :reserve, :groups, :waiter, :outdoor, :takeout]
+      )
+    end
+  end
+end

data/lib/fb_graph2/struct/restaurant_specialties.rb

@@ -0,0 +1,9 @@
+module FbGraph2
+  class Struct
+    class RestaurantSpecialties < Struct
+      register_attributes(
+        int_flag: [:coffee, :drinks, :breakfast, :dinner, :lunch]
+      )
+    end
+  end
+end

data/lib/fb_graph2/struct/work.rb

@@ -0,0 +1,11 @@
+module FbGraph2
+  class Struct
+    class Work < Struct
+      register_attributes(
+        page: [:employer, :location, :position],
+        pages: [:projects],
+        time: [:start_date, :end_date]
+      )
+    end
+  end
+end

data/lib/fb_graph2/user.rb

@@ -69,7 +69,21 @@ module FbGraph2
 
     def initialize(id, attributes = {})
       super
-      # TODO: handle custom attributes.
+      if attributes.include? :age_range
+        self.age_range = Struct::AgeRange.new attributes[:age_range]
+      end
+      if attributes.include? :context
+        self.context = Struct::Context::UserContext.new attributes[:context]
+      end
+      if attributes.include? :currency
+        self.currency = Struct::Currency.new attributes[:currency]
+      end
+      if attributes.include? :education
+        self.education = Struct::Education.new attributes[:education]
+      end
+      if attributes.include? :work
+        self.work = Struct::Work.new attributes[:work]
+      end
     end
 
     def self.me(access_token)

data/lib/fb_graph2.rb

@@ -2,8 +2,9 @@ require 'active_support/all'
 require 'rack/oauth2'
 
 module FbGraph2
-  cattr_accessor :api_version, :gem_version, :logger, :debugging, :_http_config_, :object_classes
+  cattr_accessor :root_url, :api_version, :gem_version, :logger, :debugging, :_http_config_, :object_classes
 
+  self.root_url = 'https://graph.facebook.com'
   self.api_version = 'v2.0'
   self.gem_version = File.read(File.join(__dir__, '../VERSION')).delete("\n\r")
   self.logger = Logger.new(STDOUT)
@@ -11,10 +12,6 @@ module FbGraph2
   self.object_classes = Array.new
 
   class << self
-    def root_url
-      File.join('https://graph.facebook.com', api_version)
-    end
-
     def debugging?
       !!self.debugging
     end

data/spec/fb_graph2/node_spec.rb

@@ -4,6 +4,58 @@ describe FbGraph2::Node do
   let(:klass) { FbGraph2::Node }
   let(:instance) { klass.new 'identifier' }
 
+  describe 'API Versioning' do
+    before do
+      @original = FbGraph2.api_version
+    end
+
+    after do
+      FbGraph2.api_version = @original
+    end
+
+    describe 'via global setting' do
+      before do
+        FbGraph2.api_version = 'v2.x'
+      end
+
+      describe '#fetch' do
+        it 'should use api_version globally' do
+          expect do
+            instance.fetch
+          end.to request_to 'v2.x/identifier', :get, api_version_in_path: true
+        end
+      end
+
+      describe '#edge' do
+        it 'should use api_version globally' do
+          expect do
+            instance.edge :foo
+          end.to request_to 'v2.x/identifier/foo', :get, api_version_in_path: true
+        end
+      end
+    end
+
+    describe 'via per-call option' do
+      describe '#fetch' do
+        it 'should use api_version locally' do
+          expect do
+            instance.fetch nil, api_version: 'v2.y'
+          end.to request_to 'v2.y/identifier', :get, api_version_in_path: true
+          FbGraph2.api_version.should == @original
+        end
+      end
+
+      describe '#edge' do
+        it 'should use api_version locally' do
+          expect do
+            instance.edge :foo, {}, api_version: 'v2.y'
+          end.to request_to 'v2.y/identifier/foo', :get, api_version_in_path: true
+          FbGraph2.api_version.should == @original
+        end
+      end
+    end
+  end
+
   context 'class' do
     subject { klass }
     it { should_not respond_to :register_attributes }
@@ -14,7 +66,7 @@ describe FbGraph2::Node do
       it 'should call API' do
         expect do
           klass.fetch 'foo'
-        end.to request_to '/foo'
+        end.to request_to 'foo'
       end
     end
   end
@@ -51,8 +103,8 @@ describe FbGraph2::Node do
                 instance.fetch
               end
             end.to raise_error { |e|
-              e.should be_instance_of RuntimeError
-              e.message.should == mock_json('error/400/2500')
+              e.should be_instance_of FbGraph2::Exception::BadRequest
+              e.message.should == mock_json('error/400/2500')[:error][:message]
             }
           end
         end
@@ -64,8 +116,8 @@ describe FbGraph2::Node do
                 instance.fetch
               end
             end.to raise_error { |e|
-              e.should be_instance_of RuntimeError
-              e.message.should == mock_json('error/invalid_format')
+              e.should be_instance_of FbGraph2::Exception
+              e.message.should == "Unparsable Response: #{mock_json('error/invalid_format')}"
             }
           end
         end

data/spec/fb_graph2_spec.rb

@@ -7,7 +7,7 @@ describe FbGraph2 do
   context 'as default' do
     its(:logger) { should be_a Logger }
     its(:api_version) { should == 'v2.0' }
-    its(:root_url) { should == 'https://graph.facebook.com/v2.0' }
+    its(:root_url) { should == 'https://graph.facebook.com' }
     its(:object_classes) { should contain_exactly *FbGraph2::Node.subclasses }
     it { should_not be_debugging }
   end
@@ -17,11 +17,6 @@ describe FbGraph2 do
     it { should be_debugging }
   end
 
-  describe '.api_version' do
-    before { FbGraph2.api_version = 'v2.x' }
-    its(:root_url) { should == 'https://graph.facebook.com/v2.x' }
-  end
-
   describe '.http_client' do
     context 'with http_config' do
       before do

data/spec/spec_helper/mock_graph.rb

@@ -4,7 +4,7 @@ module MockGraph
   def mock_graph(method, path, response_path, options = {})
     stub_request(
       method,
-      endpoint_for(path)
+      endpoint_for(path, options)
     ).with(
       request_for(method, options)
     ).to_return(
@@ -23,21 +23,27 @@ module MockGraph
   end
 
   def mock_json(response_path)
-    response_for(response_path)[:body].read
+    content = response_for(response_path)[:body].read
+    MultiJson.load(content).with_indifferent_access
+  rescue MultiJson::DecodeError
+    content
   end
 
-  def request_to(path, method = :get)
+  def request_to(path, method = :get, options = {})
     raise_error { |e|
       e.should be_instance_of WebMock::NetConnectNotAllowedError
       e.message.should include("Unregistered request: #{method.to_s.upcase}")
-      e.message.should include(endpoint_for path)
+      e.message.should include(endpoint_for path, options)
     }
   end
 
   private
 
-  def endpoint_for(path)
-    File.join(FbGraph2.root_url, path)
+  def endpoint_for(path, options = {})
+    api_version = unless options[:api_version_in_path]
+      options[:api_version] || FbGraph2.api_version
+    end
+    File.join FbGraph2.root_url, api_version.to_s, path
   end
 
   def request_for(method, options = {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fb_graph2
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - nov matake
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2014-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -144,6 +144,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -157,6 +158,7 @@ files:
 - lib/fb_graph2/app.rb
 - lib/fb_graph2/app_link_host.rb
 - lib/fb_graph2/attribute_assigner.rb
+- lib/fb_graph2/auth.rb
 - lib/fb_graph2/collection.rb
 - lib/fb_graph2/comment.rb
 - lib/fb_graph2/domain.rb
@@ -226,6 +228,7 @@ files:
 - lib/fb_graph2/edge/translations.rb
 - lib/fb_graph2/edge/videos.rb
 - lib/fb_graph2/event.rb
+- lib/fb_graph2/exception.rb
 - lib/fb_graph2/friend_list.rb
 - lib/fb_graph2/group.rb
 - lib/fb_graph2/group_doc.rb
@@ -247,18 +250,28 @@ files:
 - lib/fb_graph2/review.rb
 - lib/fb_graph2/struct.rb
 - lib/fb_graph2/struct/action.rb
+- lib/fb_graph2/struct/age_range.rb
 - lib/fb_graph2/struct/app_event_type.rb
 - lib/fb_graph2/struct/app_link.rb
+- lib/fb_graph2/struct/context.rb
+- lib/fb_graph2/struct/currency.rb
+- lib/fb_graph2/struct/education.rb
 - lib/fb_graph2/struct/group_file.rb
 - lib/fb_graph2/struct/image_source.rb
 - lib/fb_graph2/struct/invitable_friend.rb
+- lib/fb_graph2/struct/location.rb
+- lib/fb_graph2/struct/parking.rb
+- lib/fb_graph2/struct/payment_options.rb
 - lib/fb_graph2/struct/permission.rb
 - lib/fb_graph2/struct/picture.rb
 - lib/fb_graph2/struct/poke.rb
+- lib/fb_graph2/struct/restaurant_services.rb
+- lib/fb_graph2/struct/restaurant_specialties.rb
 - lib/fb_graph2/struct/role.rb
 - lib/fb_graph2/struct/score.rb
 - lib/fb_graph2/struct/static_resource.rb
 - lib/fb_graph2/struct/subscription.rb
+- lib/fb_graph2/struct/work.rb
 - lib/fb_graph2/thread.rb
 - lib/fb_graph2/translation.rb
 - lib/fb_graph2/user.rb
@@ -376,7 +389,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Facebook Graph API v2.0 Wrapper in Ruby