koala 1.10.0rc → 1.10.0rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25a25033e35b0e687e7bb6031e32927ff5874841
-  data.tar.gz: ffd9a57bdb9e2ecc42c28fee1747d13ee8bb277f
+  metadata.gz: b13d1518c051e76b003501281c71fdad6bcf3aad
+  data.tar.gz: 33d572064130127326b8e6ade6381bbb6a22fec4
 SHA512:
-  metadata.gz: 2f72aa59b3f6b967e5b2aa9501827e1a8cdb0e4a392063a00b806d5cad43e37086797c1fe69d0da59ede5c4a963650c238ee54fdf26401902ca586f8214f7214
-  data.tar.gz: cdb59b3cf357b2ef6d99e6106582899f9bff5db23d04bbdef46d29eea09274b0e1ba2ffc60cac25d5f157f3f18045be6f95885e8241351f8db3016113146a9f7
+  metadata.gz: 7e0df1d828fc7fdcbae60923971f06c515b6e0e1811308fcb2a20085c6f3703d2c13e70e5215b9fecb05b5cf0f95a41429ed479d45530198613163ee61111561
+  data.tar.gz: 716418c731ab9ca3e7ed87427b82142024f8762914d34c64cc12d9e9ef9ad988a29fe071ac602fa41c6a98515de2a3b580d8faceab710874f60528cce7b8d939

data/changelog.md

@@ -8,12 +8,14 @@ New features:
 
 Updated features:
 * API calls won't modify argument hashes in place anymore (thanks, MSex!)
+* OAuth#dialog_url now uses https rather than http
 
 Testing improvements:
 * Use the modern RSpec syntax (thanks, loganhasson!)
 
 Documentation improvements:
 * Properly document the timeout option (thanks, bachand!)
+* The gemspec now includes the license (thanks, coreyhaines!)
 
 v1.9.0
 ======

data/koala.gemspec

@@ -6,6 +6,7 @@ Gem::Specification.new do |gem|
   gem.name        = "koala"
   gem.summary     = "A lightweight, flexible library for Facebook with support for the Graph API, the REST API, realtime updates, and OAuth authentication."
   gem.description = "Koala is a lightweight, flexible Ruby SDK for Facebook.  It allows read/write access to the social graph via the Graph and REST APIs, as well as support for realtime updates and OAuth and Facebook Connect authentication.  Koala is fully tested and supports Net::HTTP and Typhoeus connections out of the box and can accept custom modules for other services."
+  gem.licenses    = ['MIT']
   gem.homepage    = "http://github.com/arsduo/koala"
   gem.version     = Koala::VERSION
 

data/lib/koala/api.rb

@@ -65,10 +65,6 @@ module Koala
 
         # 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/http_service.rb

@@ -47,12 +47,17 @@ module Koala
     # @option options :video use the server designated for video uploads
     # @option options :beta use the beta tier
     # @option options :use_ssl force https, even if not needed
+    # @option options :api_version a version of the Facebook API, e.g. v2.0
     #
     # @return a complete server address with protocol
     def self.server(options = {})
       server = "#{options[:rest_api] ? Koala.config.rest_server : Koala.config.graph_server}"
       server.gsub!(Koala.config.host_path_matcher, Koala.config.video_replace) if options[:video]
       server.gsub!(Koala.config.host_path_matcher, Koala.config.beta_replace) if options[:beta]
+      # ...and an API version if specified
+      if api_version = options[:api_version] || Koala.config.api_version
+        server = "#{server}/#{api_version}"
+      end
       "#{options[:use_ssl] ? "https" : "http"}://#{server}"
     end
 

data/lib/koala/oauth.rb

@@ -90,7 +90,7 @@ module Koala
         url_options = {:client_id => @app_id}.merge(options)
 
         # Creates the URL for oauth authorization for a given callback and optional set of permissions
-        build_url("https://#{Koala.config.dialog_host}/dialog/oauth", true, url_options)
+        build_url(:dialog_host, "/dialog/oauth", true, url_options)
       end
 
       # Once you receive an OAuth code, you need to redeem it from Facebook using an appropriate URL.
@@ -114,7 +114,7 @@ module Koala
           :code => code,
           :client_secret => @app_secret
         }.merge(options)
-        build_url("https://#{Koala.config.graph_server}/oauth/access_token", true, url_options)
+        build_url(:graph_server, "/oauth/access_token", true, url_options)
       end
 
       # Builds a URL for a given dialog (feed, friends, OAuth, pay, send, etc.)
@@ -129,7 +129,7 @@ module Koala
       def url_for_dialog(dialog_type, options = {})
         # some endpoints require app_id, some client_id, supply both doesn't seem to hurt
         url_options = {:app_id => @app_id, :client_id => @app_id}.merge(options)
-        build_url("http://#{Koala.config.dialog_host}/dialog/#{dialog_type}", true, url_options)
+        build_url(:dialog_host, "/dialog/#{dialog_type}", true, url_options)
       end
 
       # Generates a 'client code' from a server side long-lived access token. With the generated
@@ -376,12 +376,21 @@ module Koala
         Base64.decode64(str.tr('-_', '+/'))
       end
 
-      def build_url(base, require_redirect_uri = false, url_options = {})
+      def server_url(type)
+        url = "https://#{Koala.config.send(type)}"
+        if version = Koala.config.api_version
+          "#{url}/#{version}"
+        else
+          url
+        end
+      end
+
+      def build_url(type, path, require_redirect_uri = false, url_options = {})
         if require_redirect_uri && !(url_options[:redirect_uri] ||= url_options.delete(:callback) || @oauth_callback_url)
           raise ArgumentError, "build_url must get a callback either from the OAuth object or in the parameters!"
         end
-
-        "#{base}?#{Koala::HTTPService.encode_params(url_options)}"
+        params = Koala::HTTPService.encode_params(url_options)
+        "#{server_url(type)}#{path}?#{params}"
       end
     end
   end

data/lib/koala/version.rb

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

data/readme.md

@@ -14,7 +14,7 @@ Installation
 
 In Bundler:
 ```ruby
-gem "koala", "~> 1.9.0"
+gem "koala", "~> 1.10.0rc"
 ```
 
 Otherwise:
@@ -51,15 +51,15 @@ friends = @graph.get_connections("me", "friends")
 # 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:
+# Facebook is now versioning their API. # 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.
+#
+# 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.

data/spec/cases/api_spec.rb

@@ -146,43 +146,6 @@ describe "Koala::Facebook::API" do
         @service.api(path)
       end
     end
-
-    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
 
   describe "with an access token" do

data/spec/cases/http_service_spec.rb

@@ -76,12 +76,26 @@ describe Koala::HTTPService do
   describe "server" do
     describe "with no options" do
       it "returns the REST server if options[:rest_api]" do
-        expect(Koala::HTTPService.server(:rest_api => true)).to match(Regexp.new(Koala.config.rest_server))
+        expect(Koala::HTTPService.server(:rest_api => true)).to eq(
+         "http://#{Koala.config.rest_server}"
+        )
       end
 
       it "returns the graph server if !options[:rest_api]" do
-        expect(Koala::HTTPService.server(:rest_api => false)).to match(Regexp.new(Koala.config.graph_server))
-        expect(Koala::HTTPService.server({})).to match(Regexp.new(Koala.config.graph_server))
+        expect(Koala::HTTPService.server(:rest_api => false)).to eq(
+          "http://#{Koala.config.graph_server}"
+        )
+        expect(Koala::HTTPService.server({})).to eq(
+          "http://#{Koala.config.graph_server}"
+        )
+      end
+
+      context "with use_ssl" do
+        it "includes https" do
+          expect(Koala::HTTPService.server(use_ssl: true)).to eq(
+            "https://#{Koala.config.graph_server}"
+          )
+        end
       end
     end
 
@@ -116,6 +130,23 @@ describe Koala::HTTPService do
         expect(server).to match(Regexp.new(Koala.config.graph_server.gsub(/\.facebook/, "-video.facebook")))
       end
     end
+
+    context "with API versions" do
+      it "adds a version if specified by Koala.config" do
+        Koala.config.api_version = "v1000.000"
+        expect(Koala::HTTPService.server).to eq(
+          "http://#{Koala.config.graph_server}/#{Koala.config.api_version}"
+        )
+      end
+
+      it "prefers a version set in the options" do
+        Koala.config.api_version = "v1000.000"
+        version = "v2.0"
+        expect(Koala::HTTPService.server(api_version: version)).to eq(
+          "http://#{Koala.config.graph_server}/#{version}"
+        )
+      end
+    end
   end
 
   describe ".encode_params" do

data/spec/cases/oauth_spec.rb

@@ -244,6 +244,12 @@ describe "Koala::Facebook::OAuth" do
         expect(url).to match_url("https://#{Koala.config.dialog_host}/dialog/oauth?client_id=#{@app_id}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
+      it "includes the api version if specified" do
+        version = Koala.config.api_version = "v.2.2.2.2"
+        url = @oauth.url_for_oauth_code
+        expect(url).to match_url("https://#{Koala.config.dialog_host}/#{version}/dialog/oauth?client_id=#{@app_id}&redirect_uri=#{CGI.escape @callback_url}")
+      end
+
       it "generates a properly formatted OAuth code URL when a callback is given" do
         callback = "foo.com"
         url = @oauth.url_for_oauth_code(:callback => callback)
@@ -302,6 +308,12 @@ describe "Koala::Facebook::OAuth" do
         expect(url).to match_url("https://#{Koala.config.graph_server}/oauth/access_token?client_id=#{@app_id}&code=#{@code}&client_secret=#{@secret}&redirect_uri=#{CGI.escape @callback_url}")
       end
 
+      it "includes the api version if specified" do
+        version = Koala.config.api_version = "v.2.2.2.2"
+        url = @oauth.url_for_access_token(@code)
+        expect(url).to match_url("https://#{Koala.config.graph_server}/#{version}/oauth/access_token?client_id=#{@app_id}&code=#{@code}&client_secret=#{@secret}&redirect_uri=#{CGI.escape @callback_url}")
+      end
+
       it "generates a properly formatted OAuth token URL when provided a callback" do
         callback = "foo.com"
         url = @oauth.url_for_access_token(@code, :callback => callback)
@@ -323,7 +335,13 @@ describe "Koala::Facebook::OAuth" do
     describe "#url_for_dialog" do
       it "builds the base properly" do
         dialog_type = "my_dialog_type"
-        expect(@oauth.url_for_dialog(dialog_type)).to match(/^http:\/\/#{Koala.config.dialog_host}\/dialog\/#{dialog_type}/)
+        expect(@oauth.url_for_dialog(dialog_type)).to match(/^https:\/\/#{Koala.config.dialog_host}\/dialog\/#{dialog_type}/)
+      end
+
+      it "includes the api version if specified" do
+        version = Koala.config.api_version = "v.2.2.2.2"
+        dialog_type = "my_dialog_type"
+        expect(@oauth.url_for_dialog(dialog_type)).to match("https:\/\/#{Koala.config.dialog_host}\/#{version}\/dialog\/#{dialog_type}")
       end
 
       it "adds the app_id/client_id to the url" do
@@ -352,22 +370,22 @@ describe "Koala::Facebook::OAuth" do
         # slightly brittle (e.g. if parameter order changes), but still useful
         it "can generate a send dialog" do
           url = @oauth.url_for_dialog("send", :name => "People Argue Just to Win", :link => "http://www.nytimes.com/2011/06/15/arts/people-argue-just-to-win-scholars-assert.html")
-          expect(url).to match_url("http://www.facebook.com/dialog/send?app_id=#{@app_id}&client_id=#{@app_id}&link=http%3A%2F%2Fwww.nytimes.com%2F2011%2F06%2F15%2Farts%2Fpeople-argue-just-to-win-scholars-assert.html&name=People+Argue+Just+to+Win&redirect_uri=#{CGI.escape @callback_url}")
+          expect(url).to match_url("https://www.facebook.com/dialog/send?app_id=#{@app_id}&client_id=#{@app_id}&link=http%3A%2F%2Fwww.nytimes.com%2F2011%2F06%2F15%2Farts%2Fpeople-argue-just-to-win-scholars-assert.html&name=People+Argue+Just+to+Win&redirect_uri=#{CGI.escape @callback_url}")
         end
 
         it "can generate a feed dialog" do
           url = @oauth.url_for_dialog("feed", :name => "People Argue Just to Win", :link => "http://www.nytimes.com/2011/06/15/arts/people-argue-just-to-win-scholars-assert.html")
-          expect(url).to match_url("http://www.facebook.com/dialog/feed?app_id=#{@app_id}&client_id=#{@app_id}&link=http%3A%2F%2Fwww.nytimes.com%2F2011%2F06%2F15%2Farts%2Fpeople-argue-just-to-win-scholars-assert.html&name=People+Argue+Just+to+Win&redirect_uri=#{CGI.escape @callback_url}")
+          expect(url).to match_url("https://www.facebook.com/dialog/feed?app_id=#{@app_id}&client_id=#{@app_id}&link=http%3A%2F%2Fwww.nytimes.com%2F2011%2F06%2F15%2Farts%2Fpeople-argue-just-to-win-scholars-assert.html&name=People+Argue+Just+to+Win&redirect_uri=#{CGI.escape @callback_url}")
         end
 
         it "can generate a oauth dialog" do
           url = @oauth.url_for_dialog("oauth", :scope => "email", :response_type => "token")
-          expect(url).to match_url("http://www.facebook.com/dialog/oauth?app_id=#{@app_id}&client_id=#{@app_id}&redirect_uri=#{CGI.escape @callback_url}&response_type=token&scope=email")
+          expect(url).to match_url("https://www.facebook.com/dialog/oauth?app_id=#{@app_id}&client_id=#{@app_id}&redirect_uri=#{CGI.escape @callback_url}&response_type=token&scope=email")
         end
 
         it "can generate a pay dialog" do
           url = @oauth.url_for_dialog("pay", :order_id => "foo", :credits_purchase => false)
-          expect(url).to match_url("http://www.facebook.com/dialog/pay?app_id=#{@app_id}&client_id=#{@app_id}&order_id=foo&credits_purchase=false&redirect_uri=#{CGI.escape @callback_url}")
+          expect(url).to match_url("https://www.facebook.com/dialog/pay?app_id=#{@app_id}&client_id=#{@app_id}&order_id=foo&credits_purchase=false&redirect_uri=#{CGI.escape @callback_url}")
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 1.10.0rc
+  version: 1.10.0rc2
 platform: ruby
 authors:
 - Alex Koppel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-17 00:00:00.000000000 Z
+date: 2014-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -123,7 +123,8 @@ files:
 - spec/support/rest_api_shared_examples.rb
 - spec/support/uploadable_io_shared_examples.rb
 homepage: http://github.com/arsduo/koala
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: