live_paper 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 150824532bc144af1c7efd5005578e51d843a966
-  data.tar.gz: 68b48ce5fdc74376878078de4c9c16c3fc221023
+  metadata.gz: 1c8909429faeddd085edf073d104a1ad717b67c6
+  data.tar.gz: af646c3ccc94ac5f67e9e27b8b9e8c27542096aa
 SHA512:
-  metadata.gz: 65f7056b9a7d6d9490051fb4e12d39808e6806948783224b05fec4888a7c439933545e1630cd9588a2edfb4421d94563da8bd6c7f1c3296ced411c383fe6a947
-  data.tar.gz: 3f53715224edf9e668d23d3988f7678e45fcd22a982a052e1557399be7c8ab4d2a505ba7baaa653e0112fab52d5bf60308b05463ff166c401a980fe942f1dd74
+  metadata.gz: bbf2eb746d0325c2e4b1ba2860969b7b20a04df9ffd1c3b558f170470c20b0825d2b7d1dfca1f379614fb31a3c82ae6eb3aa2a0c13464dfed1e3a755c7b464bc
+  data.tar.gz: 30f24581fe65c6120f7e42ffc63bced8b59d0438db7225db153b549332ef8a8c31a1097f0709239a5616daaf833d53aaae63e6e3435fe3631833b55498aeca5c

data/lib/live_paper.rb

@@ -3,6 +3,7 @@ require "live_paper/http_client"
 require "live_paper/image"
 require "live_paper/link"
 require "live_paper/payoff"
+require "live_paper/trigger"
 require "live_paper/wm_trigger"
 require "live_paper/qr_trigger"
 require "live_paper/short_trigger"

data/lib/live_paper/base_object.rb

@@ -37,6 +37,45 @@ module LivePaper
       end rescue nil
     end
 
+    def self.list
+      objects=[]
+      request_handling_auth("#{api_url}", 'GET') do |request|
+        response = send_request(request, content_type: 'application/json')
+        JSON.parse(response.body, symbolize_names: true)[list_key].each do |linkdata|
+          objects << self.parse({item_key => linkdata}.to_json)
+        end
+      end #rescue nil
+      objects
+    end
+
+    def update
+      puts 'update called'
+      response_code = 'Object Invalid'
+      if self.id
+        BaseObject.request_handling_auth("#{self.class.api_url}/#{id}", 'PUT') do |request|
+          response = BaseObject.send_request(request,
+                                             content_type: 'application/json',
+                                             body: update_body.to_json,
+                                             allow_codes: [200, 400, 404, 409])
+          response_code = case response.code.to_i
+            when 200
+              puts "update response 200"
+              parse(response.body)
+              'OK'
+            when 400
+              @errors=response.body
+              'Bad Request'
+            when 409
+              @errors=response.body
+              'Conflict'
+            else
+              'Object Invalid'
+          end
+        end
+      end
+      response_code
+    end
+
     def delete
       response_code = nil
       if self.id
@@ -76,6 +115,14 @@ module LivePaper
       raise NotImplementedError
     end
 
+    def self.list_key
+      raise NotImplementedError
+    end
+
+    def self.item_key
+      raise NotImplementedError
+    end
+
     def rel(key)
       link.find { |obj| obj[:rel] == key }[:href] rescue nil
     end
@@ -109,5 +156,9 @@ module LivePaper
     def create_body
       raise NotImplementedError
     end
+
+    def update_body
+      raise NotImplementedError
+    end
   end
 end

data/lib/live_paper/http_client.rb

@@ -32,6 +32,7 @@ module LivePaper
         request_access_token unless @access_token
         request = http_request(url, method)
         request['Authorization'] = "Bearer #{@access_token}"
+        request['Accept'] = "application/json"
         yield request
       rescue NotAuthenticatedError => e
         tries += 1
@@ -63,6 +64,8 @@ module LivePaper
           Net::HTTP::Post.new(uri.request_uri)
         when 'GET'
           Net::HTTP::Get.new(uri.request_uri)
+        when 'PUT'
+          Net::HTTP::Put.new(uri.request_uri)
         when 'DELETE'
           Net::HTTP::Delete.new(uri.request_uri)
         else

data/lib/live_paper/link.rb

@@ -5,7 +5,8 @@ module LivePaper
     attr_accessor :payoff_id, :trigger_id
 
     def parse(jsondata)
-      data = JSON.parse(jsondata, symbolize_names: true)[:link]
+      puts "parsing data and it is #{jsondata}"
+      data = JSON.parse(jsondata, symbolize_names: true)[self.class.item_key]
       assign_attributes data
       self
     end
@@ -23,6 +24,14 @@ module LivePaper
       "#{LP_API_HOST}/api/v1/links"
     end
 
+    def self.list_key
+      :links
+    end
+
+    def self.item_key
+      :link
+    end
+
     private
     def validate_attributes!
       raise ArgumentError, 'Required Attributes needed: name, payoff_id and trigger_id.' unless all_present? [@name, @payoff_id, @trigger_id]
@@ -37,5 +46,14 @@ module LivePaper
         }
       }
     end
+
+    def update_body
+      {
+        link: {
+          name: @name
+        }
+      }
+    end
+
   end
 end

data/lib/live_paper/payoff.rb

@@ -10,12 +10,20 @@ module LivePaper
     }
 
     def parse(data)
-      data = JSON.parse(data, symbolize_names: true)[:payoff]
+      data = JSON.parse(data, symbolize_names: true)[self.class.item_key]
       assign_attributes(data)
       send(present?(data[:richPayoff]) ? :parse_richpayoff : :parse_webpayoff, data)
       self
     end
 
+    def self.list_key
+      :payoffs
+    end
+
+    def self.item_key
+      :payoff
+    end
+
     def self.api_url
       "#{LP_API_HOST}/api/v1/payoffs"
     end
@@ -40,6 +48,10 @@ module LivePaper
       @url = data[:URL]
     end
 
+    def update_body
+      create_body
+    end
+
     def create_body
       {
         payoff: case @type
@@ -67,7 +79,7 @@ module LivePaper
           version: 1,
           private: {
             :'content-type' => @data_type,
-            :data => @data
+            :data => Base64.encode64(@data.to_json)
           },
           public: {url: @url}
         }

data/lib/live_paper/qr_trigger.rb

@@ -1,8 +1,8 @@
 require_relative 'base_object'
 
 module LivePaper
-  class QrTrigger < BaseObject
-    attr_accessor :subscription, :qrcode_url
+  class QrTrigger < Trigger
+    attr_accessor :qrcode_url
 
     DEFAULT_SUBSCRIPTION = :month
 
@@ -13,10 +13,6 @@ module LivePaper
       self
     end
 
-    def self.api_url
-      "#{LP_API_HOST}/api/v1/triggers"
-    end
-
     def download_qrcode
       QrTrigger.request_handling_auth(self.qrcode_url, 'GET') do |request|
         response = QrTrigger.send_request(request)

data/lib/live_paper/short_trigger.rb

@@ -1,8 +1,8 @@
 require_relative 'base_object'
 
 module LivePaper
-  class ShortTrigger < BaseObject
-    attr_accessor :subscription, :short_url
+  class ShortTrigger < Trigger
+    attr_accessor :short_url
 
     DEFAULT_SUBSCRIPTION = :month
 
@@ -13,10 +13,6 @@ module LivePaper
       self
     end
 
-    def self.api_url
-      "#{LP_API_HOST}/api/v1/triggers"
-    end
-
     private
     def validate_attributes!
       raise ArgumentError, 'Required Attributes needed: name' unless all_present? [@name]

data/lib/live_paper/trigger.rb

@@ -0,0 +1,44 @@
+require_relative 'base_object'
+
+module LivePaper
+  class Trigger < BaseObject
+    attr_accessor :subscription, :state
+
+    def self.api_url
+      "#{LP_API_HOST}/api/v1/triggers"
+    end
+
+    def self.item_key
+      :trigger
+    end
+
+    def self.list_key
+      :triggers
+    end
+
+    def self.parse(data_in)
+      data = JSON.parse(data_in, symbolize_names: true)[item_key]
+      trigger_class = case data[:type]
+        when "shorturl"
+          ShortTrigger
+        when "qrcode"
+          QrTrigger
+        when "watermark"
+          WmTrigger
+        else
+          raise "UnsupportedTriggerType"
+      end
+      trigger_class.new.parse(data_in)
+    end
+
+    private
+    def update_body
+      {
+        trigger: {
+          name: @name
+        }
+      }
+    end
+  end
+
+end

data/lib/live_paper/version.rb

@@ -1,3 +1,3 @@
 module LivePaper
-  VERSION = "0.0.11"
+  VERSION = "0.0.12"
 end

data/lib/live_paper/wm_trigger.rb

@@ -1,8 +1,8 @@
 require_relative 'base_object'
 
 module LivePaper
-  class WmTrigger < BaseObject
-    attr_accessor :watermark, :subscription, :wm_url
+  class WmTrigger < Trigger
+    attr_accessor :watermark, :wm_url
     WATERMARK_RESOLUTION = 75
     WATERMARK_STRENGTH = 10
     DEFAULT_SUBSCRIPTION = :month
@@ -14,10 +14,6 @@ module LivePaper
       self
     end
 
-    def self.api_url
-      "#{LP_API_HOST}/api/v1/triggers"
-    end
-
     def download_watermark
       WmTrigger.request_handling_auth(self.wm_url, 'GET') do |request|
         response = WmTrigger.send_request(request)

data/spec/live_paper/base_object_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'json'
 
 def stub_unimplemented_methods
   allow_any_instance_of(LivePaper::BaseObject).to receive(:validate_attributes!)
@@ -101,6 +102,30 @@ describe LivePaper::BaseObject do
     end
   end
 
+  describe '.list' do
+    before do
+      allow(LivePaper::BaseObject).to receive(:api_url).and_return(@api_url)
+      allow(LivePaper::BaseObject).to receive(:list_key).and_return(:lists)
+      allow(LivePaper::BaseObject).to receive(:item_key).and_return(:list)
+      @data = {lists: [{id: 1, name: 'first'},
+                       {id: 2, name: 'second'},
+                       {id: 3, name: 'third'}
+      ]}
+      stub_request(:get, "#{@api_url}").to_return(:body => @data.to_json, :status => 200)
+    end
+    it 'should return array of parsed objects' do
+      allow(@data).to receive(:body).and_return(@data)
+      @data[:lists].each do |datum|
+        expect(LivePaper::BaseObject).to receive(:parse).with({:list => datum}.to_json) { datum[:id] }
+      end
+      result = LivePaper::BaseObject.list
+      expect(result.count).to eq @data[:lists].size
+      result.each_with_index do |res, i|
+        expect(res).to eq i+1
+      end
+    end
+  end
+
   describe '.get' do
     before do
       allow(LivePaper::BaseObject).to receive(:api_url).and_return(@api_url)
@@ -127,6 +152,89 @@ describe LivePaper::BaseObject do
     end
   end
 
+  describe '.update' do
+    let(:obj_id) { 12345 }
+    let(:update_json) { {name: 'new_name'}.to_json }
+    let (:data1) { {name: 'name',
+                    id: obj_id,
+                    date_created: 'date_created',
+                    date_modified: 'date_modified'} }
+    let(:resp_body) { }
+
+    before do
+      stub_unimplemented_methods
+      allow_any_instance_of(LivePaper::BaseObject).to receive(:update_body).and_return(update_json)
+    end
+
+    context 'with valid data' do
+      let(:resp_body) { { object: {name: new_name,
+                          id: obj_id,
+                          date_created: 'date_created',
+                          date_modified: 'new_date_modified'}} }
+      let(:new_name) { 'my_valid_name_change' }
+     before do
+       @response = resp_body
+        stub_request(:put, "#{@api_url}/#{obj_id}").to_return(:body => @response, :status => 200)
+        @obj=LivePaper::BaseObject.new data1
+        @obj.name = new_name
+      end
+      it 'should return success' do
+        ret_val = @obj.update
+        assert_requested :put, "#{@api_url}/#{obj_id}"
+        expect(ret_val).to eq 'OK'
+      end
+      xit 'should reflect the updated object' do
+        allow(@response).to receive(:body).and_return(@response[:object])
+        allow(@obj).to receive(:parse) { |data| data }
+        @obj.update
+        assert_requested :put, "#{@api_url}/#{obj_id}"
+        expect(@obj).to receive(:parse).with(resp_body)
+
+        expect(@obj.name).to eq new_name
+        expect(@obj.date_modified).to eq 'new_date_modified'
+      end
+
+    end
+
+    context 'with invalid data' do
+      before do
+        stub_request(:put, "#{@api_url}/#{obj_id}").to_return(:body => resp_body, :status => 400)
+        @obj=LivePaper::BaseObject.new data1
+        @obj.name = 'my_new_name'
+      end
+      it 'should return the error details' do
+        ret_val = @obj.update
+        assert_requested :put, "#{@api_url}/#{obj_id}"
+        expect(ret_val).to eq 'Bad Request'
+      end
+      it 'should preserve the invalid object attributes' do
+        @obj.update
+        assert_requested :put, "#{@api_url}/#{obj_id}"
+        expect(@obj.name).to eq 'my_new_name'
+      end
+    end
+
+    context 'remote object has been deleted' do
+      before do
+        stub_request(:put, "#{@api_url}/#{obj_id}").to_return(:body => resp_body, :status => 404)
+      end
+      it 'should return an error' do
+        @obj=LivePaper::BaseObject.new data1
+        ret_val = @obj.update
+        assert_requested :put, "#{@api_url}/#{obj_id}"
+        expect(ret_val).to eq 'Object Invalid'
+      end
+    end
+
+    context 'remote object was never saved.' do
+      it 'should return an error' do
+        @obj = LivePaper::BaseObject.new @data
+        ret_val = @obj.update
+        expect(ret_val).to eq 'Object Invalid'
+      end
+    end
+  end
+
   describe '.delete' do
     before do
       stub_unimplemented_methods
@@ -136,8 +244,8 @@ describe LivePaper::BaseObject do
         date_created: 'date_created',
         date_modified: 'date_modified',
         link: [
-          { :rel => "self", :href => "/api/v1/objects/obj_id" },
-          { :rel => "analytics", :href => "/analytics/v1/objects/obj_id" }
+          {:rel => "self", :href => "/api/v1/objects/obj_id"},
+          {:rel => "analytics", :href => "/analytics/v1/objects/obj_id"}
         ]
       }
       @obj = LivePaper::BaseObject.create @data
@@ -184,8 +292,8 @@ describe LivePaper::BaseObject do
         date_created: 'date_created',
         date_modified: 'date_modified',
         link: [
-          { :rel => "self", :href => "/api/v1/payoffs/payoff_id" },
-          { :rel => "analytics", :href => "/analytics/v1/payoffs/payoff_id" }
+          {:rel => "self", :href => "/api/v1/payoffs/payoff_id"},
+          {:rel => "analytics", :href => "/analytics/v1/payoffs/payoff_id"}
         ]
       }
       @obj = LivePaper::BaseObject.create @data

data/spec/live_paper/link_spec.rb

@@ -83,10 +83,10 @@ describe LivePaper::Link do
     it 'should map the link array attribute.' do
       expect(@link.link).to be_a Array
       expect(@link.link.size).to eq 4
-      expect(@link.link).to eq [{:rel=>"self", :href=>"self_url"},
-                                {:rel=>"analytics", :href=>"analytic_url"},
-                                {:rel=>"payoff", :href=>"payoff_url"},
-                                {:rel=>"trigger", :href=>"trigger_url"}]
+      expect(@link.link).to eq [{:rel => "self", :href => "self_url"},
+                                {:rel => "analytics", :href => "analytic_url"},
+                                {:rel => "payoff", :href => "payoff_url"},
+                                {:rel => "trigger", :href => "trigger_url"}]
     end
 
     it 'should map the trigger_id attribute.' do
@@ -125,6 +125,31 @@ describe LivePaper::Link do
     end
   end
 
+  describe '.update' do
+    let(:newname) { 'my_new_name' }
+    before do
+      @link = LivePaper::Link.new @data
+      stub_request(:put, "#{LivePaper::Link.api_url}/#{@data[:id]}").to_return(:body => lpp_link_response_json(newname), :status => 200)
+      @link.name = newname
+      @link.update
+    end
+
+    it 'should make a PUT to the link URL with the parse body.' do
+      assert_requested :put, "#{LivePaper::Link.api_url}/#{@data[:id]}", :body => {
+        link: {
+          name: newname
+        }
+      }.to_json
+    end
+
+    it 'should reflect the data returned' do
+      expect(@link.name).to eq newname
+      expect(@link.date_modified).to eq '2014-04-08T08:16:25.723+0000'
+    end
+
+
+  end
+
   describe '#trigger' do
     before do
       stub_request(:get, "#{LivePaper::WmTrigger.api_url}/trigger_id").to_return(:body => lpp_trigger_response_json, :status => 200)

data/spec/live_paper/payoff_spec.rb

@@ -61,7 +61,7 @@ describe LivePaper::Payoff do
                 version: 1,
                 private: {
                   :'content-type' => 'data_type',
-                  :data => 'data'
+                  :data => Base64.encode64('data'.to_json)
                 },
                 public: {
                   url: 'url'

data/spec/live_paper/trigger_spec.rb

@@ -99,7 +99,7 @@ describe LivePaper::WmTrigger do
   describe '.get' do
     context 'the requested trigger exists.' do
       before do
-        @trigger = LivePaper::WmTrigger.get('trigger_id')
+        @trigger = LivePaper::Trigger.get('trigger_id')
       end
 
       it 'should return the requested trigger.' do
@@ -108,15 +108,33 @@ describe LivePaper::WmTrigger do
         expect(@trigger.watermark).to eq 'watermark'
         expect(@trigger.subscription).to eq 'subscription'
       end
+
+      context 'qr trigger' do
+        before do
+          stub_request(:get, "#{LivePaper::Trigger.api_url}/qr_trigger_id").to_return(:body => lpp_trigger_response_json('qrcode'), :status => 200)
+        end
+        it 'should create a QrTrigger' do
+          qr_trigger = LivePaper::Trigger.get('qr_trigger_id')
+          expect(qr_trigger).to be_a LivePaper::QrTrigger
+        end
+      end
+
+      context 'short trigger' do
+        it 'should return a ShortTrigger' do
+          stub_request(:get, "#{LivePaper::Trigger.api_url}/short_trigger_id").to_return(:body => lpp_trigger_response_json('shorturl'), :status => 200)
+          my_trigger = LivePaper::Trigger.get('short_trigger_id')
+          expect(my_trigger).to be_a LivePaper::ShortTrigger
+        end
+      end
     end
 
     context 'the requested trigger does not exist or some error happened.' do
       it 'should not raise error.' do
-        expect { LivePaper::WmTrigger.get('trigger_not_existent') }.to_not raise_error
+        expect { LivePaper::Trigger.get('trigger_not_existent') }.to_not raise_error
       end
 
       it 'should return nil.' do
-        expect(LivePaper::WmTrigger.get('trigger_not_existent')).to eq nil
+        expect(LivePaper::Trigger.get('trigger_not_existent')).to eq nil
       end
     end
   end

data/spec/spec_helpers/lpp_client.rb

@@ -54,26 +54,35 @@ def lpp_richpayoff_response_json
   RESPONSE
 end
 
-def lpp_trigger_response_json
+def lpp_trigger_response_json(type='watermark')
   <<-RESPONSE
 {
   "trigger": {
     "id": "trigger_id",
     "name": "name",
+        "dateCreated": "2014-10-08T22:06:28.518+0000",
+        "dateModified": "2014-10-08T22:06:28.518+0000",
+    "link": [
+      {"rel":"self", "href": "https://www.livepaperapi.com/api/v1/triggers/trigger_id"},
+      {"rel":"analytics", "href": "https://www.livepaperapi.com/analytics/v1/triggers/trigger_id"},
+      {"rel":"image", "href": "https://fileapi/trigger_id/image"},
+      {"rel":"shortURL", "href": "http://hpgo.co/abc123"}
+    ],
+    "state": "ACTIVE",
+    "type": "#{type}",
     "watermark": "watermark",
-    "link": [{"rel":"image", "href": "https://fileapi/id/image"}],
     "subscription": "subscription"
   }
 }
   RESPONSE
 end
 
-def lpp_link_response_json
+def lpp_link_response_json(name='name')
   <<-RESPONSE
 {
   "link": {
     "id": "link_id",
-    "name": "name",
+    "name": "#{name}",
     "dateCreated": "2014-04-08T08:16:25.723+0000",
     "dateModified": "2014-04-08T08:16:25.723+0000",
     "link": [{

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live_paper
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Mike Whitmarsh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-05 00:00:00.000000000 Z
+date: 2014-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -101,6 +101,7 @@ files:
 - lib/live_paper/payoff.rb
 - lib/live_paper/qr_trigger.rb
 - lib/live_paper/short_trigger.rb
+- lib/live_paper/trigger.rb
 - lib/live_paper/version.rb
 - lib/live_paper/wm_trigger.rb
 - live_paper.gemspec