koala 2.0.0 → 2.2.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cee1d15d3263d9cdfffa910b9127b4d6e177f844
-  data.tar.gz: db07b6f8a9443e34c717671756daa41138c408c0
+  metadata.gz: 97051729d27eccc4d97c5140394556293d181446
+  data.tar.gz: 0a4fba738c9919c43e570107a54024e23d167b83
 SHA512:
-  metadata.gz: ccba6c6fc0b52f5c22582f2438f53968c6e23c458d329be8cf18a997554043a8e433e97f464e03affdfcda6f530cd90b354ac8f6a0cf05d26ff72a23990bf69d
-  data.tar.gz: 33484fe1e975f2a3808f928a967ff7d054c8495f9185dd4975ce448cb301dbe9002b756d72d4e0a7bc9739e13f90ef42ed4f66254aeec83c0231841dc6df22ef
+  metadata.gz: a8083a54eff541caa07259f10a937e5500ae35cdf1323b6085f1f87287e2b9bdfc8f9dab7287ae326d360b570e75219e080b3b17b99fda008db56e3889374517
+  data.tar.gz: 3a5d6929a14c0cbcc96384314cadb85c0cd8b4feb1ebfede3bdb427676b990f2c25abb936d61d49eb32de51aa141390c5af000468ebe5bcfa2577d01ef41fdaf

data/.gitignore

@@ -5,4 +5,5 @@ Gemfile.lock
 *.rbc
 *~
 .yardoc/
-.DS_Store
+.DS_Store
+coverage

data/.travis.yml

@@ -12,3 +12,6 @@ rvm:
   # jruby
   - jruby-19mode
 bundler_args: --without development
+addons:
+  code_climate:
+    repo_token: 7af99d9225b4c14640f9ec3cb2e24d2f7103ac49417b0bd989188fb6c25f2909

data/Gemfile

@@ -15,6 +15,7 @@ group :test do
   gem "rspec", '~> 3.0.0.beta1'
   gem "vcr"
   gem "webmock"
+  gem "codeclimate-test-reporter", require: nil
 end
 
 gem "jruby-openssl" if defined? JRUBY_VERSION

data/changelog.md

@@ -1,3 +1,26 @@
+v2.2.0
+======
+
+Updated features:
+
+* You can now specify format: :json in http_options to make Content-Type application/json requests (thanks, adparlor!)
+* Koala now supports uploading videos by URL (thanks, filipegiusti!)
+
+Internal Improvements:
+
+* Use MultiJson::LoadError instead of the newer ParseError for backward compatibility (thanks, bunshin!)
+
+Documentation improvements:
+
+* modernize the hash syntax in the readme (thanks, st0012!)
+
+v2.1.0
+======
+
+Documentation improvements:
+
+* extend/clean up code quality badges (thanks, jbender!)
+
 v2.0.0
 ======
 

data/lib/koala/api.rb

@@ -37,6 +37,10 @@ module Koala
       # @param options request-related options for Koala and Faraday.
       #                See https://github.com/arsduo/koala/wiki/HTTP-Services for additional options.
       # @option options [Symbol] :http_component which part of the response (headers, body, or status) to return
+      # @option options [Symbol] :format which request format to use. Currently, :json is supported
+      # @option options [Symbol] :preserve_form_arguments preserve arrays in arguments, which are
+      #                          expected by certain FB APIs (see the ads API in particular,
+      #                          https://developers.facebook.com/docs/marketing-api/adgroup/v2.4)
       # @option options [Boolean] :beta use Facebook's beta tier
       # @option options [Boolean] :use_ssl force SSL for this request, even if it's tokenless.
       #                                    (All API requests with access tokens use SSL.)
@@ -61,7 +65,7 @@ module Koala
         end
 
         # Translate any arrays in the params into comma-separated strings
-        args = sanitize_request_parameters(args)
+        args = sanitize_request_parameters(args) unless preserve_form_arguments?(options)
 
         # add a leading / if needed...
         path = "/#{path}" unless path =~ /^\//
@@ -105,8 +109,12 @@ module Koala
           result.merge(key => value)
         end
       end
+
+      def preserve_form_arguments?(options)
+        options[:format] == :json || options[:preserve_form_arguments] || Koala.config.preserve_form_arguments
+      end
     end
   end
 end
 
-require 'koala/api/graph_batch_api'
+require 'koala/api/graph_batch_api'

data/lib/koala/api/graph_api.rb

@@ -222,7 +222,8 @@ module Koala
         put_connections(*parse_media_args(picture_args, "photos"), &block)
       end
 
-      # Upload a video.  Functions exactly the same as put_picture.
+      # Upload a video.  Functions exactly the same as put_picture (URLs supported as of Facebook
+      # API version 2.3).
       # @see #put_picture
       def put_video(*video_args, &block)
         args = parse_media_args(video_args, "videos")
@@ -557,7 +558,9 @@ module Koala
 
         if url?(media_args.first)
           # If media_args is a URL, we can upload without UploadableIO
-          args.merge!(:url => media_args.first)
+          # Video: https://developers.facebook.com/docs/graph-api/video-uploads
+          fb_expected_arg_name = method == "photos" ? :url : :file_url
+          args.merge!(fb_expected_arg_name => media_args.first)
         else
           args["source"] = Koala::UploadableIO.new(*media_args.slice(0, 1 + args_offset))
         end

data/lib/koala/http_service.rb

@@ -74,7 +74,7 @@ module Koala
     #
     # @return [Koala::HTTPService::Response] a response object representing the results from Facebook
     def self.make_request(path, args, verb, options = {})
-      # if the verb isn't get or post, send it as a post argument
+      # if the verb isn't get or post, send it as a post argument with a method param
       args.merge!({:method => verb}) && verb = "post" if verb != "get" && verb != "post"
 
       # turn all the keys to strings (Faraday has issues with symbols under 1.8.7) and resolve UploadableIOs
@@ -101,7 +101,17 @@ module Koala
       # we have to manually assign params to the URL or the
       conn = Faraday.new(server(request_options), faraday_options(request_options), &(faraday_middleware || DEFAULT_MIDDLEWARE))
 
-      response = conn.send(verb, path, (verb == "post" ? params : {}))
+      # remember, all non-GET requests are turned into POSTs -- see the the start of this method
+      if verb == "post" && options[:format] == :json
+        response = conn.post do |req|
+          req.path = path
+          req.headers["Content-Type"] = "application/json"
+          req.body = params.to_json
+          req
+        end
+      else
+        response = conn.send(verb, path, (verb == "post" ? params : {}))
+      end
 
       # Log URL information
       Koala::Utils.debug "#{verb.upcase}: #{path} params: #{params.inspect}"

data/lib/koala/oauth.rb

@@ -261,7 +261,7 @@ module Koala
 
       def parse_access_token(response_text)
         MultiJson.load(response_text)
-      rescue MultiJson::ParseError
+      rescue MultiJson::LoadError
         response_text.split("&").inject({}) do |hash, bit|
           key, value = bit.split("=")
           hash.merge!(key => value)

data/lib/koala/version.rb

@@ -1,3 +1,3 @@
 module Koala
-  VERSION = "2.0.0"
+  VERSION = "2.2.0rc1"
 end

data/readme.md

@@ -1,7 +1,4 @@
-[![Build Status](https://secure.travis-ci.org/arsduo/koala.png)](http://travis-ci.org/arsduo/koala)
-[![Code Climate](https://codeclimate.com/github/arsduo/koala.png)](https://codeclimate.com/github/arsduo/koala)
-
-Koala
+Koala [![Version](https://img.shields.io/gem/v/koala.svg)](https://rubygems.org/gems/koala) [![Dependencies](https://img.shields.io/gemnasium/arsduo/koala.svg)](https://gemnasium.com/arsduo/koala) [![Build Status](https://img.shields.io/travis/arsduo/koala.svg)](http://travis-ci.org/arsduo/koala) [![Code Climate](https://img.shields.io/codeclimate/github/arsduo/koala.svg)](https://codeclimate.com/github/arsduo/koala) [![Code Coverage](https://img.shields.io/codeclimate/coverage/github/arsduo/koala.svg)](https://codeclimate.com/github/arsduo/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:
 
@@ -43,14 +40,14 @@ Then, go exploring:
 
 profile = @graph.get_object("me")
 friends = @graph.get_connections("me", "friends")
-@graph.put_connections("me", "feed", :message => "I am writing on my wall!")
+@graph.put_connections("me", "feed", message: "I am writing on my wall!")
 
 # Three-part queries are easy too!
 @graph.get_connections("me", "mutualfriends/#{friend_id}")
 
 # You can use the Timeline API:
 # (see https://developers.facebook.com/docs/beta/opengraph/tutorial/)
-@graph.put_connections("me", "namespace:action", :object => object_url)
+@graph.put_connections("me", "namespace:action", object: object_url)
 
 # For extra security (recommended), you can provide an appsecret parameter,
 # tying your access tokens to your app secret.
@@ -197,7 +194,7 @@ Sometimes, reaching out to Facebook is a pain -- let it reach out to you instead
 
 Koala makes it easy to interact with your applications using the RealtimeUpdates class:
 ```ruby
-@updates = Koala::Facebook::RealtimeUpdates.new(:app_id => app_id, :secret => secret)
+@updates = Koala::Facebook::RealtimeUpdates.new(app_id: app_id, secret: secret)
 ```
 You can do just about anything with your real-time update subscriptions using the RealtimeUpdates class:
 ```ruby
@@ -222,7 +219,7 @@ Test Users
 
 We also support the test users API, allowing you to conjure up fake users and command them to do your bidding using the Graph or REST API:
 ```ruby
-@test_users = Koala::Facebook::TestUsers.new(:app_id => id, :secret => secret)
+@test_users = Koala::Facebook::TestUsers.new(app_id: id, secret: secret)
 user = @test_users.create(is_app_installed, desired_permissions)
 user_graph_api = Koala::Facebook::API.new(user["access_token"])
 # or, if you want to make a whole community:
@@ -235,10 +232,10 @@ Koala uses Faraday to make HTTP requests, which means you have complete control
 ```ruby
 # Set an SSL certificate to avoid Net::HTTP errors
 Koala.http_service.http_options = {
-  :ssl => { :ca_path => "/etc/ssl/certs" }
+  ssl: { ca_path: "/etc/ssl/certs" }
 }
 # or on a per-request basis
-@api.get_object(id, args_hash, { :request => { :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

@@ -75,7 +75,7 @@ describe "Koala::Facebook::API" do
     expect(@service.api('anything', {}, 'get', :http_component => http_component)).to eq(response)
   end
 
-  it "turns arrays of non-enumerables into comma-separated arguments" do
+  it "turns arrays of non-enumerables into comma-separated arguments by default" do
     args = [12345, {:foo => [1, 2, "3", :four]}]
     expected = ["/12345", {:foo => "1,2,3,four"}, "get", {}]
     response = double('Mock KoalaResponse', :body => '', :status => 200)
@@ -83,6 +83,26 @@ describe "Koala::Facebook::API" do
     @service.api(*args)
   end
 
+  it "can be configured to leave arrays of non-enumerables as is" do
+    Koala.configure do |config|
+      config.preserve_form_arguments = true
+    end
+
+    args = [12345, {:foo => [1, 2, "3", :four]}]
+    expected = ["/12345", {:foo => [1, 2, "3", :four]}, "get", {}]
+    response = double('Mock KoalaResponse', :body => '', :status => 200)
+    expect(Koala).to receive(:make_request).with(*expected).and_return(response)
+    @service.api(*args)
+  end
+
+  it "can be configured on a per-request basis to leave arrays as is" do
+    args = [12345, {foo: [1, 2, "3", :four]}, "get", preserve_form_arguments: true]
+    expected = ["/12345", {foo: [1, 2, "3", :four]}, "get", preserve_form_arguments: true]
+    response = double('Mock KoalaResponse', :body => '', :status => 200)
+    expect(Koala).to receive(:make_request).with(*expected).and_return(response)
+    @service.api(*args)
+  end
+
   it "doesn't turn arrays containing enumerables into comma-separated strings" do
     params = {:foo => [1, 2, ["3"], :four]}
     args = [12345, params]
@@ -95,6 +115,14 @@ describe "Koala::Facebook::API" do
     @service.api(*args)
   end
 
+  it "doesn't modify any data if the option format of :json is provided" do
+    args = [12345, {:foo => [1, 2, "3", :four]}, 'get', format: :json]
+    expected = ["/12345", {:foo => [1, 2, "3", :four]}, 'get', format: :json]
+    response = double('Mock KoalaResponse', :body => '', :status => 200)
+    expect(Koala).to receive(:make_request).with(*expected).and_return(response)
+    @service.api(*args)
+  end
+
   it "returns the body of the request as JSON if no http_component is given" do
     response = double('response', :body => 'body', :status => 200)
     allow(Koala).to receive(:make_request).and_return(response)

data/spec/cases/http_service_spec.rb

@@ -252,6 +252,30 @@ describe Koala::HTTPService do
         Koala::HTTPService.make_request("anything", {"access_token" => "foo"}, "get", options)
       end
 
+      it "calls server with a json object when provided a format option for post requests" do
+        # Unstub the now somewhat regrettable stubbing above
+        allow(Faraday).to receive(:new).and_call_original
+
+        mock_request_klass = Class.new do
+          attr_accessor :path, :body, :headers, :status
+          def initialize
+            @headers = {}
+          end
+        end
+
+        mock_request = mock_request_klass.new
+        allow_any_instance_of(Faraday::Connection).to receive(:post).and_yield(mock_request)
+
+        path = "California"
+        args = {:a => 2, :c => "3"}
+
+        Koala::HTTPService.make_request(path, args, "post", format: :json)
+
+        expect(mock_request.path).to eq(path)
+        expect(mock_request.headers).to eq("Content-Type" => "application/json")
+        expect(mock_request.body).to eq(args.to_json)
+      end
+
       it "calls server with the composite options" do
         options = {:a => 2, :c => "3"}
         http_options = {:a => :a}

data/spec/fixtures/mock_facebook_responses.yml

@@ -194,6 +194,14 @@ graph_api:
       post:
         <<: *token_required
         with_token: '{"id": "MOCK_PHOTO"}'
+    file_url=http://techslides.com/demos/sample-videos/small.mp4:
+      post:
+        <<: *token_required
+        with_token: '{"id": "MOCK_PHOTO_FROM_URL"}'
+    description=my message&file_url=http://techslides.com/demos/sample-videos/small.mp4:
+      post:
+        <<: *token_required
+        with_token: '{"id": "MOCK_PHOTO_FROM_URL"}'
 
   /koppel:
     no_args:

data/spec/spec_helper.rb

@@ -1,3 +1,7 @@
+# Quantify coverage
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 # load the library
 require 'koala'
 
@@ -8,4 +12,4 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 # load testing data and (if needed) create test users or validate real users
 KoalaTest.setup_test_environment!
 
-BEACH_BALL_PATH = File.join(File.dirname(__FILE__), "fixtures", "beach.jpg")
+BEACH_BALL_PATH = File.join(File.dirname(__FILE__), "fixtures", "beach.jpg")

data/spec/support/graph_api_shared_examples.rb

@@ -358,6 +358,25 @@ shared_examples_for "Koala GraphAPI with an access token" do
     # note: Facebook doesn't post videos immediately to the wall, due to processing time
     # during which get_object(video_id) will return false
     # hence we can't do the same verify test we do for photos
+
+
+    describe "using a URL instead of a file" do
+      before :each do
+        @url = "http://techslides.com/demos/sample-videos/small.mp4"
+      end
+
+      it "can post photo to the user's wall using a URL" do
+        result = @api.put_video(@url)
+        @temporary_object_id = result["id"]
+        expect(@temporary_object_id).not_to be_nil
+      end
+
+      it "can post photo to the user's wall using a URL and an additional param" do
+        result = @api.put_video(@url, :description => "my message")
+        @temporary_object_id = result["id"]
+        expect(@temporary_object_id).not_to be_nil
+      end
+    end
   end
 
   it "can verify a message with an attachment posted to a feed" do

data/spec/support/koala_test.rb

@@ -225,6 +225,7 @@ module KoalaTest
     VCR.configure do |c|
       c.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
       c.hook_into :webmock # or :fakeweb
+      c.ignore_hosts 'codeclimate.com' # Allow test coverage to be reported
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koala
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0rc1
 platform: ruby
 authors:
 - Alex Koppel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2015-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -141,12 +141,12 @@ 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
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A lightweight, flexible library for Facebook with support for the Graph API,