buff 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3e891d111f7733cd52ef4cbd52b53cb2acabab6
-  data.tar.gz: 357899d36e7488127e46b03f36f7ad0a3eefa715
+  metadata.gz: f5cb0c530979c636b2ac80ac80b3b35b7d5a9fd7
+  data.tar.gz: 62293ac07b6119a4e43dd0339f8efa7143ccf9f9
 SHA512:
-  metadata.gz: af4fd75e337c70021cd21a1fcf7a960d571ada956d9b8cd1a3e2ed184f4e79cd70476decfb4838fdd31a1dfb669e3fa9dcd3141f1927be046ae96a8e70b78b71
-  data.tar.gz: 31ff60c79b65e92510ff20245c45b6179ebdfb002ef83da36f852f8b4e2226bbcf0dabcb3cf861f8f0ccb9dbe677e06dcff749a9e20c8e0ffa83bd5266846d43
+  metadata.gz: d91ca034732471dbdb7b71e0d4156adbf43a3cf687d6355b6f1560dad3eb2a172dd5230a72f10694ad0adfc47bcba741e9f918e463bf0ded16def658774b2a56
+  data.tar.gz: 798fa7a5620e33aee0c77cfcc0d892edf894dea9756a9061cd414eeb3e6e17b0554bce6c41ca77f3b0a03d4177cc531a1cfe8c42cd0dca03b733d5cbbb4963c8

data/README.md

@@ -2,7 +2,8 @@
 
 Buff is a Buffer API Wrapper written in Ruby.  It provides more thorough API coverage than the existing gem.
 
-Since the gem is currently in ALPHA development, the interface is prone to change.  Please wait until v0.1.0 is released to become reliant on interface.
+Since the gem is currently in ALPHA development, the interface is prone to change.  Please wait until v0.1.0 is released to become reliant on interface. As it stands, all of the basic API calls in BufferApp's spec are available.  Some of the optional params are yet to be implemented.
+
 
 ## Installation
 
@@ -14,7 +15,7 @@ Once Buff is released as a gem, the following instructions will work. For now pl
 
 Add this line to your application's Gemfile:
 
-    gem 'buff', :git => 'zph/buff'
+    gem 'buff', :github => 'zph/buff'
 
 And then execute:
 
@@ -27,25 +28,25 @@ Once gem is pushed to RubyGems:
 
 ## Usage
 
-  * Note which API coverage exists and have fun!
-  * Authentication is not included in this gem (Try OAuth-buffer)
+  * Note that some of the optional params are not implemented!
+  * All methods are tested with Rspec and WebMock. Not all methods have integration tests that reach out to the live Buffer API servers.  Proceed with caution until Buff reaches v0.1.0 and submit issues on Github Issues tab.
+  * Authentication is not included in this gem (Try OAuth-buffer) or use the single API key given when registering your own Buffer Dev credentials.
 
 ## API Coverage
 
 #### Implemented
 
 * User
-* Profiles (:get)
-* Updates (:get)
-* Updates (:post, #create_update, #change_update_text, #destroy_update, #share_update, #shuffle_updates, #reorder_updates)
+* Profiles (:get, :post)
+* Updates (:get, :post)
 * Links
 * Info
 * Error Codes
 
 #### Not Implemented
 
-* Profiles (:post, #set_schedules)
 * Caching
+* Various optional params
 
 ## Contributing
 
@@ -55,8 +56,8 @@ Once gem is pushed to RubyGems:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-Issues, advice and refactoring is welcome.
+Issues, refactoring, and feedback are all welcome.
 
 Also, this project is newcomer friendly!! We'd love to be your first Open Source Software contribution and would be happy to assist in that process.
 
-Reach out on Twitter [@_ZPH](http://twitter.com/_ZPH).
+Crafted with care by Zander. Reach out and say hi at [@_ZPH](http://twitter.com/_ZPH)

data/lib/buff.rb

@@ -2,6 +2,7 @@ require "faraday"
 require "faraday_middleware"
 require "json"
 require "rash"
+require "addressable/uri"
 
 require "buff/version"
 require "buff/core"

data/lib/buff/core.rb

@@ -15,6 +15,8 @@ module Buff
         interpret_response(response)
       end
 
+      #TODO post data isn't limited to body requests in post
+      #split out the options data separately
       def post(path, post_data)
         @conn.post do |req|
           req.url path.gsub(%r{^\/}, '')

data/lib/buff/encode.rb

@@ -1,8 +1,21 @@
 module Buff
   class Encode
-    def self.encode(hash)
-      raise ArgumentError unless hash.is_a?(Hash)
+    def self.encode(arg)
+      if arg.respond_to?(:keys)
+        arg = arg[:schedules]
+      end
 
+      output = []
+      arg.each_with_index do |item, index|
+        uri = Addressable::URI.new
+        uri.query_values = item
+        pairs = uri.query.split("&").map do |pair|
+          key , value = pair.split("=")
+          "schedules[#{index}][#{key}][]=#{value}"
+        end
+        output << pairs.join("&")
+      end
+      output.join("&")
     end
   end
 end

data/lib/buff/profile.rb

@@ -16,12 +16,10 @@ module Buff
         response.map { |r| Buff::Schedule.new(r) }
       end
 
-      # TODO massive bug
-      # currently deletes schedule due to malformed request
       def set_schedules(id, options={})
-        # schedules = options.fetch(:schedules) { raise ArgumentError }
-        response = post("/profiles/#{id}/schedules/update.json", options )
-          Buff::Response.new(JSON.parse(response.body))
+        schedules = Buff::Encode.encode(options.fetch(:schedules) { raise ArgumentError })
+        response = post("/profiles/#{id}/schedules/update.json", schedules: schedules )
+        Buff::Response.new(JSON.parse(response.body))
       end
     end
   end

data/lib/buff/update.rb

@@ -30,7 +30,7 @@ module Buff
 
       def reorder_updates(profile_id, options={})
         # order, optional: offset, utc
-        order = options.fetch(:order) { raise ArgumentError }
+        options.fetch(:order) { raise ArgumentError }
         response = post("/profiles/#{profile_id}/updates/reorder.json", options)
       end
 
@@ -41,13 +41,6 @@ module Buff
 
         #TODO
       def create_update(options={})
-
-        # POST Data
-        #     text=This%20is%20an%20example%20update&
-        #     profile_ids[]=4eb854340acb04e870000010&
-        #     profile_ids[]=4eb9276e0acb04bb81000067&
-        #     media[link]=http%3A%2F%2Fgoogle.com&
-        #     media[description]=The%20google%20homepage
         # options = {
         #   text: "bodytext",
         #   profile_ids: ["230958239058", "23059u2350923"],

data/lib/buff/version.rb

@@ -1,3 +1,3 @@
 module Buff
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/buff/encode_spec.rb

@@ -1,36 +1,72 @@
 require "spec_helper"
 
+  # describe "Addressable Explorations" do
+
+  #   describe "addressable conversions" do
+
+  #     let(:uri) { Addressable::URI.new }
+
+  #     it "should convert {:pony => 'pony' }" do
+  #       h = { pony: "pony"}
+  #       uri.query_values = h
+  #       uri.query.should eq("pony=pony")
+  #     end
+
+  #     it "should convert {:pony => ['pony', 'horse'] }" do
+  #       h = { pony: ["pony", "horse"]}
+  #       uri.query_values = h
+  #       uri.query.should eq("pony=pony&pony=horse")
+  #     end
+
+  #     it "should convert {:days => [mon, tues], :times => [....]}" do
+  #       h = { days: ["mon", "tue"], times: ["12:00", "13:00"]}
+  #       uri.query_values = h
+  #       uri.query.should eq("days=mon&days=tue&times=12%3A00&times=13%3A00")
+  #     end
+  #     xit "should convert {schedules => {:days => [mon, tues], :times => [....]}" do
+  #       h = { schedules: { :days => ["mon", "tue", "wed", "thu"], :times => ["12:00", "13:00"]} }
+  #       # h = {:a => "a", :bd => ["c", "d", "e"]}
+  #       uri.query_values = h
+  #       uri.query.should eq("days=mon&days=tue&times=12%3A00&times=13%3A00")
+  #     end
+  #   end
 describe Buff::Encode do
-  describe "#encode" do
 
-    let(:uri) { Addressable::URI.new }
-    it "throws error unless input is a hash" do
-      lambda { Buff::Encode.encode([]) }.
-        should raise_error(ArgumentError)
-    end
+  context "successful code" do
+
+  let(:schedule_first) { { :days => ["mon", "tue", "wed", "thu"], :times => ["12:00", "13:00"]} }
+  let(:schedule_second) { { :days => ["sun", "sat"], :times => ["09:00", "24:00"]} }
+  let(:schedules_hash) { { schedules: [schedule_first, schedule_second] } }
+  let(:short_schedule) { { days: ["mon", "tue", "wed"], times: ["12:00", "17:00", "18:00"]} }
+  let(:short_schedule_encoded) { "[days][]=mon&[days][]=tue&[times][]=12%3A00&[times][]=13%3A00" }
+  let(:schedules_encoded) { "schedules[0][days][]=mon&schedules[0][days][]=tue&schedules[0][days][]=wed&schedules[0][times][]=12:00&schedules[0][times][]=17:00&schedules[0][times][]=18:00" }
+  let(:very_short_schedule) { { :days => ["sun", "sat"], :times => ["09:00", "24:00"]} }
 
-    it "should convert {:pony => 'pony' }" do
-      h = { pony: "pony"}
-      uri.query_values = h
-      uri.query.should eq("pony=pony")
+
+  describe "#encode"
+    it "converts to match Buffer API specs encoding" do
+      Buff::Encode.encode([short_schedule]).
+        should eq(schedules_encoded.gsub(/:/, '%3A'))
     end
 
-    it "should convert {:pony => ['pony', 'horse'] }" do
-      h = { pony: ["pony", "horse"]}
-      uri.query_values = h
-      uri.query.should eq("pony=pony&pony=horse")
+    it "processes an input array of schedules" do
+      Buff::Encode.encode([very_short_schedule, very_short_schedule]).
+        should eq("schedules[0][days][]=sun&schedules[0][days][]=sat&schedules[0][times][]=09%3A00&schedules[0][times][]=24%3A00&schedules[1][days][]=sun&schedules[1][days][]=sat&schedules[1][times][]=09%3A00&schedules[1][times][]=24%3A00")
     end
 
-    it "should convert {:days => [mon, tues], :times => [....]}" do
-      h = { days: ["mon", "tue"], times: ["12:00", "13:00"]}
-      uri.query_values = h
-      uri.query.should eq("days=mon&days=tue&times=12%3A00&times=13%3A00")
+    it "includes index in conversion when multiple schedules present" do
+      Buff::Encode.encode([very_short_schedule, very_short_schedule, very_short_schedule]).
+        should eq("schedules[0][days][]=sun&schedules[0][days][]=sat&schedules[0][times][]=09%3A00&schedules[0][times][]=24%3A00&schedules[1][days][]=sun&schedules[1][days][]=sat&schedules[1][times][]=09%3A00&schedules[1][times][]=24%3A00&schedules[2][days][]=sun&schedules[2][days][]=sat&schedules[2][times][]=09%3A00&schedules[2][times][]=24%3A00")
     end
-    xit "should convert {schedules => {:days => [mon, tues], :times => [....]}" do
-      # h = { :days => ["mon", "tue", "wed", "thu"], :times => ["12:00", "13:00"]}
-      h = {:a => "a", :bd => ["c", "d", "e"]}
-      uri.query_values = h
-      uri.query.should eq("days=mon&days=tue&times=12%3A00&times=13%3A00")
+
+    it "processes an input hash" do
+      Buff::Encode.encode({ schedules: [very_short_schedule, very_short_schedule, very_short_schedule] }).
+        should eq("schedules[0][days][]=sun&schedules[0][days][]=sat&schedules[0][times][]=09%3A00&schedules[0][times][]=24%3A00&schedules[1][days][]=sun&schedules[1][days][]=sat&schedules[1][times][]=09%3A00&schedules[1][times][]=24%3A00&schedules[2][days][]=sun&schedules[2][days][]=sat&schedules[2][times][]=09%3A00&schedules[2][times][]=24%3A00")
     end
   end
+
+  describe "#encode_schedule_primary" do
+  end
+
+
 end

data/spec/lib/buff/link_spec.rb

@@ -6,8 +6,8 @@ describe Buff::Client do
     let(:url) { %q{http://bufferapp.com} }
 
     before do
-      stub_request(:get, "https://api.bufferapp.com/1/links/shares.json?access_token=some_token&url=http://bufferapp.com").
-        to_return(fixture('link.txt'))
+      stub_request(:get, "#{ base_path }/links/shares.json?#{ access_token_param }&url=http://bufferapp.com").
+      to_return(fixture('link.txt'))
     end
 
     it "connects to the correct endpoint" do

data/spec/lib/buff_spec.rb

@@ -18,9 +18,8 @@ describe Buff::Client do
     let(:rash) { subject.user_info }
 
     before(:each) do
-      stub_request(:get, 'https://api.bufferapp.com/1/user.json').
-        with(query: { 'access_token' => 'some_token'}).
-        to_return(fixture('user_authenticated.txt'))
+      url = "#{ base_path }/user.json"
+      stub_with_to_return(:get, url, "user_authenticated.txt")
     end
 
     it "returns a Rash object" do
@@ -36,9 +35,8 @@ describe Buff::Client do
     let(:rash) { Buff::Client.new("some_token").profiles }
 
     before(:each) do
-      stub_request(:get, 'https://api.bufferapp.com/1/profiles.json').
-        with(query: { 'access_token' => 'some_token'}).
-        to_return(fixture('profile_authenticated.txt'))
+      url = "#{ base_path }/profiles.json"
+      stub_with_to_return(:get, url, 'profile_authenticated.txt')
     end
 
     it "makes the correct url request" do
@@ -57,9 +55,9 @@ describe Buff::Client do
   describe "#profile_by_id" do
     let(:id) { "5160746d54f04a5e3a00000f" }
     before(:each) do
-      stub_request(:get, "https://api.bufferapp.com/1/profiles/#{id}.json").
-        with(query: { 'access_token' => 'some_token'}).
-        to_return(fixture('profiles_by_id.txt'))
+      url = "#{base_path}/profiles/#{id}.json"
+      fixture_name = "profiles_by_id.txt"
+      stub_with_to_return(:get, url, fixture_name)
     end
 
     let(:rash) { Buff::Client.new("some_token").profile_by_id(id) }
@@ -75,9 +73,9 @@ describe Buff::Client do
 
   describe "#profile_schedules_by_id" do
     before(:each) do
-      stub_request(:get, "https://api.bufferapp.com/1/profiles/#{id}/schedules.json").
-        with(query: { 'access_token' => 'some_token'}).
-        to_return(fixture('profile_schedules_by_id.txt'))
+      url = "#{base_path}/profiles/#{id}/schedules.json"
+      fixture_name = 'profile_schedules_by_id.txt'
+      stub_with_to_return(:get, url, fixture_name)
     end
 
     let(:rash) { Buff::Client.new("some_token").profile_schedules_by_id(id) }
@@ -107,7 +105,7 @@ describe Buff::Client do
 
   describe "#info" do
     before do
-      stub_request(:get, "https://api.bufferapp.com/1/info/configuration.json?access_token=some_token").
+      stub_request(:get, "#{base_path}/info/configuration.json?access_token=some_token").
         to_return(fixture("info.txt"))
     end
 
@@ -182,8 +180,7 @@ EOF
 
   it "dumping a double schedule yields correct json" do
     schedules = Buff::Schedules.new
-    schedules << @schedule
-    schedules << @schedule
+    schedules << @schedule << @schedule
     @sample_schedules = @sample_schedules.to_json
 
     schedules.dump.should eq(@sample_schedules)
@@ -195,7 +192,7 @@ describe Buff::Client::Core do
   let(:client) { Buff::Client.new("some_token") }
   describe "#get" do
     it "delegates to #handle_response_code when code != 200" do
-       stub_request(:get, "https://api.bufferapp.com/1/info/configuration.json?access_token=some_token").
+       stub_request(:get, "#{base_path}/info/configuration.json?access_token=some_token").
          to_return(:status => 403, :body => "", :headers => {})
        client.should_receive(:handle_response_code).once
        client.info
@@ -203,7 +200,7 @@ describe Buff::Client::Core do
 
 
     it "does not delegate to #handle_response_code when code = 200" do
-       stub_request(:get, "https://api.bufferapp.com/1/info/configuration.json?access_token=some_token").
+       stub_request(:get, "#{base_path}/info/configuration.json?access_token=some_token").
          to_return(fixture("link.txt"))
        client.should_not_receive(:handle_response_code)
        client.info
@@ -214,20 +211,21 @@ describe Buff::Client::Core do
 
     it "connects to the correct endpoint" do
 
-#TODO improve test
+    #TODO improve test
       response = %Q[{"success": true, "message": "Schedule saved successfully"}]
       id = "4eb854340acb04e870000010"
-      stub_request(:post, %r{https://api\.bufferapp\.com/1/profiles/4eb854340acb04e870000010/schedules/update\.json\?access_token=.*}).
-               with(:body => {"schedules"=>{"days"=>["mon", "tue", "wed"], "times"=>["12:00", "17:00", "18:00"]}},
-                    :headers => {'Accept'=>'*/*', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Faraday v0.8.7'}).
+      stub_request(:post, "#{ base_path }/profiles/#{id}/schedules/update.json?access_token=some_token").
+         with(:body => {"schedules"=>"schedules[0][days][]=mon&schedules[0][days][]=tue&schedules[0][days][]=wed&schedules[0][times][]=12%3A00&schedules[0][times][]=17%3A00&schedules[0][times][]=18%3A00"},
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/x-www-form-urlencoded', 'User-Agent'=>'Faraday v0.8.7'}).
                to_return(:status => 200, :body => response, :headers => {})
        client.set_schedules(id, :schedules => sample_schedules).success.
          should eq(true)
     end
 
     xit "does not delegate to #handle_response_code when code = 200" do
-       stub_request(:get, "https://api.bufferapp.com/1/info/configuration.json?access_token=some_token").
-         to_return(fixture("link.txt"))
+      url = "#{base_path}/info/configuration.json"
+      fixture_name = "link.txt"
+      stub_with_to_return(:get, url, fixture_name)
        client.should_not_receive(:handle_response_code)
        client.info
     end
@@ -243,9 +241,8 @@ describe Buff::Client::Core do
     context "fails gracefully with undocumented responses" do
       it "responds to 401 unauthorized response" do
         id = "4eb8565e0acb04bb82000004"
-        stub_request(:get, "https://api.bufferapp.com/1/updates/#{id}.json?access_token=some_token").
-          to_return(fixture("update_by_id_non_auth.txt"))
-
+        url = "#{base_path}/updates/#{id}.json?access_token=some_token"
+        stub_with_to_return(:get, url, "update_by_id_non_auth.txt")
         lambda { client.update_by_id(id) }.
           should raise_error(Buff::APIError)
       end

data/spec/spec_helper.rb

@@ -26,12 +26,31 @@ def sample_schedules2
       {days: %w[mon tue wed],
       times: %w[12:00 17:00 18:00]},
     ]
+
+end
+
+def base_path
+  "https://api.bufferapp.com/1"
+end
+
+def access_token_param
+  "access_token=some_token"
 end
+
+def stub_with_to_return(request_type, url, fixture_name, query_hash={})
+  query = access_hash.merge(query_hash)
+  stub_request(request_type, url).
+     with(query: query).
+     to_return(fixture(fixture_name))
+end
+
+def access_hash
+  { 'access_token' => 'some_token'}
+end
+
 def sample_schedules
-  [
     [{ days: %w[mon tue wed],
       times: %w[12:00 17:00 18:00]}]
-  ]
   # @sample_schedules = JSON.parse <<EOF
   #   [{
   #       "days" : [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: buff
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ZPH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-19 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec