koala 1.9.0 → 1.10.0rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fce15c756d8195dd27bfff27a1dfb8d22c7c17d9
-  data.tar.gz: 3544dc9c1b0ef86ca8ef8282201c5249847ce33d
+  metadata.gz: 25a25033e35b0e687e7bb6031e32927ff5874841
+  data.tar.gz: ffd9a57bdb9e2ecc42c28fee1747d13ee8bb277f
 SHA512:
-  metadata.gz: 6936a245c607107f259c0c91ec29684e14a5eab681435773b57b8135caeb52890cf8023072954122c884a6d01b44ef2eb78f8f6a8b014624a315963d42a425aa
-  data.tar.gz: 6fe435caee7dbec526eafc7309e6490af6906f3627cebb9e3510321dc067caba639ade215762a804922d2e0f02ba2bc112110ece5a442be230b3b01a81f98ab4
+  metadata.gz: 2f72aa59b3f6b967e5b2aa9501827e1a8cdb0e4a392063a00b806d5cad43e37086797c1fe69d0da59ede5c4a963650c238ee54fdf26401902ca586f8214f7214
+  data.tar.gz: cdb59b3cf357b2ef6d99e6106582899f9bff5db23d04bbdef46d29eea09274b0e1ba2ffc60cac25d5f157f3f18045be6f95885e8241351f8db3016113146a9f7

data/.travis.yml

@@ -4,8 +4,7 @@ rvm:
   - 2.0.0
   - 2.1.0
   # rbx
-  - rbx-2.1.1
-  - rbx
+  - rbx-2
   # jruby
   - jruby-19mode
 bundler_args: --without development

data/Gemfile

@@ -16,10 +16,4 @@ end
 
 gem "jruby-openssl" if defined? JRUBY_VERSION
 
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'         # if using anything in the ruby standard library
-  gem 'psych'                    # if using yaml
-  gem 'rubinius-developer_tools' # if using any of coverage, debugger, profiler
-end
-
 gemspec

data/changelog.md

@@ -1,3 +1,20 @@
+v.1.10.0
+========
+
+New features:
+* API versioning is now supported through global and per-options requests
+  (Koala.config.api_version and the :api_version key specified as a per-request
+  options)
+
+Updated features:
+* API calls won't modify argument hashes in place anymore (thanks, MSex!)
+
+Testing improvements:
+* Use the modern RSpec syntax (thanks, loganhasson!)
+
+Documentation improvements:
+* Properly document the timeout option (thanks, bachand!)
+
 v1.9.0
 ======
 

data/lib/koala.rb

@@ -35,6 +35,13 @@ module Koala
       yield config
     end
 
+    # Allows you to control various Koala configuration options.
+    # Notable options:
+    #   * server endpoints: you can override any or all the server endpoints
+    #   (see HTTPService::DEFAULT_SERVERS) if you want to run requests through
+    #   other servers.
+    #   * api_version: controls which Facebook API version to use (v1.0, v2.0,
+    #   etc)
     def config
       @config ||= OpenStruct.new(HTTPService::DEFAULT_SERVERS)
     end

data/lib/koala/api.rb

@@ -48,6 +48,10 @@ module Koala
       #
       # @return the body of the response from Facebook (unless another http_component is requested)
       def api(path, args = {}, verb = "get", options = {}, &error_checking_block)
+        # we make a copy of args so the modifications (added access_token & appsecret_proof)
+        # do not affect the received argument
+        args = args.dup
+
         # If a access token is explicitly provided, use that
         # This is explicitly needed in batch requests so GraphCollection
         # results preserve any specific access tokens provided
@@ -59,8 +63,12 @@ module Koala
         # Translate any arrays in the params into comma-separated strings
         args = sanitize_request_parameters(args)
 
-        # add a leading /
+        # add a leading / if needed...
         path = "/#{path}" unless path =~ /^\//
+        # ...and an API version if specified
+        if api_version = options[:api_version] || Koala.config.api_version
+          path = "/#{api_version}#{path}"
+        end
 
         # make the request via the provided service
         result = Koala.make_request(path, args, verb, options)

data/lib/koala/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "1.9.0"
+  VERSION = "1.10.0rc"
 end

data/readme.md

@@ -1,10 +1,5 @@
 [![Build Status](https://secure.travis-ci.org/arsduo/koala.png)](http://travis-ci.org/arsduo/koala)
 
-**Note**: a recent Facebook change will cause apps that parse the cookies every
-request to fail with the error "OAuthException: This authorization code has
-been used."  If you're seeing this, please read the note in the [OAuth
-wiki](https://github.com/arsduo/koala/wiki/OAuth) for more information.
-
 Koala
 ====
 [Koala](http://github.com/arsduo/koala) is a Facebook library for Ruby, supporting the Graph API (including the batch requests and photo uploads), the REST API, realtime updates, test users, and OAuth validation.  We wrote Koala with four goals:
@@ -19,7 +14,7 @@ Installation
 
 In Bundler:
 ```ruby
-gem "koala", "~> 1.8.0rc1"
+gem "koala", "~> 1.9.0"
 ```
 
 Otherwise:
@@ -28,7 +23,8 @@ Otherwise:
 ```
 
 Graph API
-----
+---------
+
 The Graph API is the simple, slick new interface to Facebook's data.
 Using it with Koala is quite straightforward.  First, you'll need an access token, which you can get through
 Facebook's [Graph API Explorer](https://developers.facebook.com/tools/explorer) (click on 'Get Access Token').
@@ -54,6 +50,16 @@ friends = @graph.get_connections("me", "friends")
 # You'll need to turn on 'Require proof on all calls' in the advanced section
 # of your app's settings when doing this.
 @graph = Koala::Facebook::API.new(oauth_access_token, app_secret)
+
+# Facebook is now versioning their API. You can specify version either
+globally:
+Koala.config.api_version = "v2.0"
+# or on a per-request basis
+@graph.get_object("me", {}, api_version: "v2.0")
+# If you don't specify a version, Facebook will default to the oldest version
+# your app is allowed to use. Note that apps created after f8 2014 *cannot* use
+# the v1.0 API. See https://developers.facebook.com/docs/apps/versions for more
+# information.
 ```
 
 The response of most requests is the JSON data returned from the Facebook servers as a Hash.
@@ -224,7 +230,7 @@ Koala.http_service.http_options = {
   :ssl => { :ca_path => "/etc/ssl/certs" }
 }
 # or on a per-request basis
-@api.get_object(id, args_hash, { :timeout => 10 })
+@api.get_object(id, args_hash, { :request => { :timeout => 10 } })
 ```
 The <a href="https://github.com/arsduo/koala/wiki/HTTP-Services">HTTP Services wiki page</a> has more information on what options are available, as well as on how to configure your own Faraday middleware stack (for instance, to implement request logging).
 

data/spec/cases/api_spec.rb

@@ -30,6 +30,21 @@ describe "Koala::Facebook::API" do
     service.api('anything')
   end
 
+  it "doesn't add token to received arguments" do
+    token = 'adfadf'
+    service = Koala::Facebook::API.new token
+
+    expect(Koala).to receive(:make_request).with(
+                       anything,
+                       hash_including('access_token' => token),
+                       anything,
+                       anything
+                     ).and_return(Koala::HTTPService::Response.new(200, "", ""))
+
+    args = {}.freeze
+    service.api('anything', args)
+  end
+
   it "has an attr_reader for access token" do
     token = 'adfadf'
     service = Koala::Facebook::API.new token
@@ -117,17 +132,56 @@ describe "Koala::Facebook::API" do
     expect(@service.api('anything')).to be_falsey
   end
 
-  describe "with regard to leading slashes" do
-    it "adds a leading / to the path if not present" do
-      path = "anything"
-      expect(Koala).to receive(:make_request).with("/#{path}", anything, anything, anything).and_return(Koala::HTTPService::Response.new(200, 'true', {}))
-      @service.api(path)
+  describe "path manipulation" do
+    context "leading /" do
+      it "adds a leading / to the path if not present" do
+        path = "anything"
+        expect(Koala).to receive(:make_request).with("/#{path}", anything, anything, anything).and_return(Koala::HTTPService::Response.new(200, 'true', {}))
+        @service.api(path)
+      end
+
+      it "doesn't change the path if a leading / is present" do
+        path = "/anything"
+        expect(Koala).to receive(:make_request).with(path, anything, anything, anything).and_return(Koala::HTTPService::Response.new(200, 'true', {}))
+        @service.api(path)
+      end
     end
 
-    it "doesn't change the path if a leading / is present" do
-      path = "/anything"
-      expect(Koala).to receive(:make_request).with(path, anything, anything, anything).and_return(Koala::HTTPService::Response.new(200, 'true', {}))
-      @service.api(path)
+    context "API versions" do
+      let(:path) { "/anything" }
+
+      it "adds a version if specified by Koala.config" do
+        Koala.config.api_version = "v1000.000"
+        expect(Koala).to receive(:make_request).with(
+          "/#{Koala.config.api_version}#{path}",
+          anything,
+          anything,
+          anything
+        ).and_return(Koala::HTTPService::Response.new(200, 'true', {}))
+        @service.api(path)
+      end
+
+      it "prefers a version set in the options" do
+        Koala.config.api_version = "v1000.000"
+        version = "v2.0"
+        expect(Koala).to receive(:make_request).with(
+          "/#{version}#{path}",
+          anything,
+          anything,
+          anything
+        ).and_return(Koala::HTTPService::Response.new(200, 'true', {}))
+        @service.api(path, {}, "get", api_version: "v2.0")
+      end
+
+      it "doesn't include a version if not specified" do
+        expect(Koala).to receive(:make_request).with(
+          path,
+          anything,
+          anything,
+          anything
+        ).and_return(Koala::HTTPService::Response.new(200, 'true', {}))
+        @service.api(path)
+      end
     end
   end
 
@@ -173,14 +227,14 @@ describe "Koala::Facebook::API" do
           let(:api) { Koala::Facebook::API.new(access_token, appsecret) }
 
           it "will be included by default" do
-            Koala.should_receive(:make_request).with(path, token_args.merge(appsecret_proof_args), verb, {}).and_return(response)
+            expect(Koala).to receive(:make_request).with(path, token_args.merge(appsecret_proof_args), verb, {}).and_return(response)
             api.api(path, {}, verb, :appsecret_proof => true)
           end
         end
 
         describe "but without an appsecret included on API initialization" do
           it "will not be included" do
-            Koala.should_receive(:make_request).with(path, token_args, verb, {}).and_return(response)
+            expect(Koala).to receive(:make_request).with(path, token_args, verb, {}).and_return(response)
             api.api(path, {}, verb, :appsecret_proof => true)
           end
         end
@@ -191,7 +245,7 @@ describe "Koala::Facebook::API" do
           let(:api) { Koala::Facebook::API.new(nil, appsecret) }
 
           it "will not be included" do
-            Koala.should_receive(:make_request).with(path, {}, verb, {}).and_return(response)
+            expect(Koala).to receive(:make_request).with(path, {}, verb, {}).and_return(response)
             api.api(path, {}, verb, :appsecret_proof => true)
           end
         end
@@ -200,7 +254,7 @@ describe "Koala::Facebook::API" do
           let(:api) { Koala::Facebook::API.new }
 
           it "will not be included" do
-            Koala.should_receive(:make_request).with(path, {}, verb, {}).and_return(response)
+            expect(Koala).to receive(:make_request).with(path, {}, verb, {}).and_return(response)
             api.api(path, {}, verb, :appsecret_proof => true)
           end
         end

data/spec/cases/graph_api_spec.rb

@@ -20,6 +20,12 @@ describe 'Koala::Facebook::GraphAPIMethods' do
         allow(@api).to receive(:api).and_return(double("other results"))
         expect(@api.get_object('koppel', &post_processing)["result"]).to eq(result)
       end
+
+      it "doesn't add token to received arguments" do
+        args = {}.freeze
+        expect(Koala).to receive(:make_request).and_return(Koala::HTTPService::Response.new(200, "", ""))
+        expect(@api.get_object('koppel', args, &post_processing)["result"]).to eq(result)
+      end
     end
 
     context '#get_picture' do

data/spec/cases/test_users_spec.rb

@@ -299,7 +299,7 @@ describe "Koala::Facebook::TestUsers" do
 
       if KoalaTest.mock_interface?
         id_counter = 999999900
-        allow(@test_users).to receive(:create).and_return do
+        allow(@test_users).to receive(:create) do
           id_counter += 1
           {"id" => id_counter, "access_token" => @token, "login_url" => "https://www.facebook.com/platform/test_account.."}
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0rc
 platform: ruby
 authors:
 - Alex Koppel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-08 00:00:00.000000000 Z
+date: 2014-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -140,9 +140,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.1