live_paper 0.0.8 → 0.0.9

data/lib/live_paper/qr_trigger.rb

@@ -0,0 +1,44 @@
+require_relative 'base_object'
+
+module LivePaper
+  class QrTrigger < BaseObject
+    attr_accessor :subscription, :qrcode_url
+
+    DEFAULT_SUBSCRIPTION = :month
+
+    def parse(data)
+      data = JSON.parse(data, symbolize_names: true)[:trigger]
+      assign_attributes data
+      self.qrcode_url=data[:link].select { |item| item[:rel] == "image" }.first[:href]
+      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)
+        response.body.empty? ? nil : response.body
+      end
+    end
+
+    private
+    def validate_attributes!
+      raise ArgumentError, 'Required Attributes needed: name' unless all_present? [@name]
+    end
+
+    def create_body
+      {
+        trigger: {
+          name: @name,
+          type: "qrcode",
+          subscription: {
+            package: DEFAULT_SUBSCRIPTION.to_s
+          }
+        }
+      }
+    end
+  end
+end

data/lib/live_paper/short_trigger.rb

@@ -0,0 +1,37 @@
+require_relative 'base_object'
+
+module LivePaper
+  class ShortTrigger < BaseObject
+    attr_accessor :subscription, :short_url
+
+    DEFAULT_SUBSCRIPTION = :month
+
+    def parse(data)
+      data = JSON.parse(data, symbolize_names: true)[:trigger]
+      assign_attributes data
+      self.short_url=data[:link].select { |item| item[:rel] == "shortURL" }.first[:href]
+      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]
+    end
+
+    def create_body
+      {
+        trigger: {
+          name: @name,
+          type: "shorturl",
+          subscription: {
+            package: DEFAULT_SUBSCRIPTION.to_s
+          }
+        }
+      }
+    end
+  end
+end

data/lib/live_paper/version.rb

@@ -1,3 +1,3 @@
 module LivePaper
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/live_paper/wm_trigger.rb

@@ -0,0 +1,52 @@
+require_relative 'base_object'
+
+module LivePaper
+  class WmTrigger < BaseObject
+    attr_accessor :watermark, :subscription, :wm_url
+    WATERMARK_RESOLUTION = 75
+    WATERMARK_STRENGTH = 10
+    DEFAULT_SUBSCRIPTION = :month
+
+    def parse(data)
+      data = JSON.parse(data, symbolize_names: true)[:trigger]
+      assign_attributes data
+      self.wm_url=data[:link].select { |item| item[:rel] == "image" }.first[:href]
+      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)
+        response.body.empty? ? nil : response.body
+      end
+    end
+
+    private
+    def validate_attributes!
+      raise ArgumentError, 'Required Attributes needed: name and watermark.' unless all_present? [@name, @watermark]
+      raise ArgumentError, 'Required Attributes needed: watermark[:strength] and watermark[:imageURL].' unless all_keys_present? @watermark, [:strength, :imageURL]
+    end
+
+    def create_body
+      {
+        trigger: {
+          name: @name,
+          watermark: {
+            outputImageFormat: 'JPEG',
+            resolution: WATERMARK_RESOLUTION,
+            strength: @watermark[:strength],
+            imageURL: @watermark[:imageURL]
+          },
+          subscription: {
+            package: DEFAULT_SUBSCRIPTION.to_s
+          }
+        }
+      }
+    end
+
+  end
+end

data/live_paper.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "rest-client"
-  
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
 end

data/spec/live_paper/base_object_spec.rb

@@ -0,0 +1,200 @@
+require 'spec_helper'
+
+def stub_unimplemented_methods
+  allow_any_instance_of(LivePaper::BaseObject).to receive(:validate_attributes!)
+  allow_any_instance_of(LivePaper::BaseObject).to receive(:create_body).and_return(@data)
+  allow_any_instance_of(LivePaper::BaseObject).to receive(:parse) { |data| data }
+  allow(LivePaper::BaseObject).to receive(:api_url).and_return(@api_url)
+end
+
+describe LivePaper::BaseObject do
+  before do
+    @api_url = "#{LivePaper::LP_API_HOST}/objects"
+    stub_request(:post, /.*livepaperapi.com\/auth\/token.*/).to_return(:body => lpp_auth_response_json, :status => 200)
+    stub_request(:post, @api_url).to_return(:body => lpp_richpayoff_response_json, :status => 200)
+
+    @data = {
+      name: 'name',
+      date_created: 'date_created',
+      date_modified: 'date_modified'
+    }
+
+  end
+
+  describe '#initialize' do
+    before do
+      @data = {
+        id: 'id',
+        name: 'name',
+        date_created: 'date_created',
+        date_modified: 'date_modified'
+      }
+      @object = LivePaper::BaseObject.new @data
+    end
+
+    it 'should map the id attribute.' do
+      expect(@object.id).to eq @data[:id]
+    end
+
+    it 'should map the name attribute.' do
+      expect(@object.name).to eq @data[:name]
+    end
+
+    it 'should map the date_created attribute.' do
+      expect(@object.date_created).to eq @data[:date_created]
+    end
+
+    it 'should map the date_modified attribute.' do
+      expect(@object.date_modified).to eq @data[:date_modified]
+    end
+  end
+
+  describe '#save' do
+    before do
+      stub_unimplemented_methods
+      @data = {
+        name: 'name',
+        date_created: 'date_created',
+        date_modified: 'date_modified'
+      }
+      @obj = LivePaper::BaseObject.new @data
+    end
+
+    it 'should not make a POST if the object has already an id.' do
+      @obj.id = 'id'
+      @obj.save
+      assert_not_requested :post, @api_url
+    end
+
+    it 'should re-assign the current object attributes.' do
+      @obj.save
+      expect(@obj.name).to eq @data[:name]
+      expect(@obj.date_created).to eq @data[:date_created]
+      expect(@obj.date_modified).to eq @data[:date_modified]
+    end
+
+    it 'should return the object instance.' do
+      obj = @obj.save
+      expect(obj).to eq @obj
+    end
+
+    it 'should make a POST to the api_url with the body provided.' do
+      @obj.save
+      assert_requested :post, @api_url, :body => @data.to_json
+    end
+  end
+
+  describe '.create' do
+    before do
+      stub_unimplemented_methods
+      @obj = LivePaper::BaseObject.create @data
+    end
+
+    it 'should return a object instance.' do
+      expect(@obj.class).to eq LivePaper::BaseObject
+    end
+
+    it 'should return the object instance with the provided + updated data.' do
+      expect(@obj.name).to eq @data[:name]
+      expect(@obj.date_created).to eq @data[:date_created]
+      expect(@obj.date_modified).to eq @data[:date_modified]
+    end
+  end
+
+  describe '.find' do
+    before do
+      allow(LivePaper::BaseObject).to receive(:api_url).and_return(@api_url)
+      @data = '"id": "id", "name": "name"'
+      stub_request(:get, "#{@api_url}/base_object").to_return(:body => @data, :status => 200)
+      stub_request(:get, "#{@api_url}/base_object_not_existent").to_return(:body => '{}', :status => 404)
+    end
+    context 'the requested base_object exists.' do
+      it 'should return the requested base object.' do
+        allow(@data).to receive(:body).and_return(@data)
+        expect(LivePaper::BaseObject).to receive(:parse).with(@data)
+        LivePaper::BaseObject.find('base_object')
+      end
+    end
+
+    context 'the requested base object does not exist or some error happened.' do
+      it 'should not raise error.' do
+        expect { LivePaper::BaseObject.find('base_object_not_existent') }.to_not raise_error
+      end
+
+      it 'should return nil.' do
+        expect(LivePaper::BaseObject.find('base_object_not_existent')).to eq nil
+      end
+    end
+  end
+
+  describe '#all_present?' do
+    before do
+      @all = [1, 2, {k: 'v'}, [1, 2]]
+      @some = [1, 2, {k: 'v'}, []]
+      @none = nil
+    end
+
+    it 'should return true if all elements are present.' do
+      expect(LivePaper::BaseObject.new.send(:all_present?, @all)).to eq true
+    end
+
+    it 'should return false if some element is not present.' do
+      expect(LivePaper::BaseObject.new.send(:all_present?, @some)).to eq false
+    end
+
+    it 'should return false if there is no array.' do
+      expect(LivePaper::BaseObject.new.send(:all_present?, @none)).to eq false
+    end
+  end
+
+  describe '#all_keys_present?' do
+    before do
+      @keys = [:x, :y, :z]
+      @all = {x: 10, y: 20, z: 30}
+      @some = {x: 10, y: 20}
+      @none = nil
+    end
+
+    it 'should return true if all keys are present.' do
+      expect(LivePaper::BaseObject.new.send(:all_keys_present?, @all, @keys)).to eq true
+    end
+
+    it 'should return false if some key is not present.' do
+      expect(LivePaper::BaseObject.new.send(:all_keys_present?, @some, @keys)).to eq false
+    end
+
+    it 'should return false if there is no hash.' do
+      expect(LivePaper::BaseObject.new.send(:all_keys_present?, @none, @keys)).to eq false
+    end
+  end
+
+  describe '#parse' do
+    it 'should raise exception' do
+      expect { LivePaper::BaseObject.parse('') }.to raise_error
+    end
+  end
+
+  describe '#save' do
+    it 'should raise exception' do
+      expect { LivePaper::BaseObject.new.save }.to raise_error
+    end
+  end
+
+  describe '#api_url' do
+    it 'should raise exception' do
+      expect { LivePaper::BaseObject.api_url }.to raise_error
+    end
+  end
+
+  describe '#validate_attributes!' do
+    it 'should raise exception' do
+      expect { LivePaper::BaseObject.new.send :validate_attributes! }.to raise_error
+    end
+  end
+
+  describe '#create_body' do
+    it 'should raise exception' do
+      expect { LivePaper::BaseObject.new.send :create_body }.to raise_error
+    end
+  end
+end

data/spec/live_paper/http_client_spec.rb

@@ -0,0 +1,182 @@
+require 'spec_helper'
+
+module LivePaper
+  class DummyHTTP
+    include HttpClient
+  end
+end
+
+describe LivePaper::HttpClient do
+  before do
+    $lpp_basic_auth=Base64.strict_encode64("auth:pass")
+    @http_client = LivePaper::DummyHTTP.new
+    stub_request(:post, 'https://auth:pass@www.livepaperapi.com/auth/token').to_return(:body => lpp_auth_response_json, :status => 200)
+  end
+
+  describe '#send_request' do
+
+    before(:each) do
+      @http = double('Http mock')
+      allow(@http).to receive(:request)
+      @http_client.instance_variable_set(:@http, @http)
+      @request = double('Request mock')
+      allow(@http_client).to receive(:check_response)
+    end
+
+    it 'should add the content type to the request' do
+      expect(@request).to receive(:[]=).with('Content-type', 'image/jpg')
+      allow(@request).to receive(:body=)
+      @http_client.send_request @request, 'image/jpg', 'body'
+    end
+
+    it 'should add the body to the request' do
+      expect(@request).to receive(:body=).with('body')
+      allow(@request).to receive(:[]=)
+      @http_client.send(:send_request, @request, 'image/jpg', 'body')
+    end
+
+    it 'should call the request method from the http instance' do
+      allow(@request).to receive(:body=)
+      allow(@request).to receive(:[]=)
+      expect(@http).to receive(:request)
+      @http_client.send(:send_request, @request, 'image/jpg', 'body')
+    end
+
+    it 'should check the response' do
+      allow(@request).to receive(:body=)
+      allow(@request).to receive(:[]=)
+      expect(@http_client).to receive(:check_response)
+      @http_client.send(:send_request, @request, 'image/jpg', 'body')
+    end
+  end
+
+  describe 'check_response' do
+
+    before(:each) do
+      @response = double('A mock for a response')
+      allow(@response).to receive(:body)
+    end
+
+    it 'should raise NotAuthenticatedError if the response code is 401' do
+      allow(@response).to receive(:code).and_return('401')
+      expect { @http_client.send(:check_response, @response) }.to raise_error NotAuthenticatedError
+    end
+
+    it 'should not raise any exception if the response code is 200..201' do
+      allow(@response).to receive(:code).and_return('201')
+      expect { @http_client.send(:check_response, @response) }.to_not raise_error
+    end
+
+    it 'should raise exception if the response code is other than 200..201|401' do
+      allow(@response).to receive(:code).and_return('500')
+      expect { @http_client.send(:check_response, @response) }.to raise_error
+    end
+  end
+
+  describe 'request_handling_auth' do
+
+    before(:each) do
+      @url = 'https://dev.livepaperapi.com/auth/token'
+    end
+
+    context 'when there is no access token' do
+
+      before(:each) do
+        @http_client.instance_variable_set(:@access_token, nil)
+      end
+
+      it 'should request the access token' do
+        expect(@http_client).to receive(:request_access_token)
+        @http_client.send(:request_handling_auth, @url, "POST") { |request|}
+      end
+    end
+
+    context 'when there is access token' do
+
+      before(:each) do
+        @http_client.instance_variable_set(:@access_token, 'TOPSECRET')
+      end
+
+      it 'should yield the given block' do
+        a_mock = double('Some mock')
+        expect(a_mock).to receive(:a_message)
+        @http_client.send(:request_handling_auth, @url, 'POST') do |request|
+          a_mock.a_message
+        end
+      end
+
+      context 'when the access token is invalid' do
+
+        before(:each) do
+          @http_client.instance_variable_set(:@access_token, 'INVALID')
+        end
+
+        it 'should retry max 3 times' do
+          a_mock = double('Some mock')
+          expect(a_mock).to receive(:a_message).at_least(:twice)
+          begin
+            @http_client.send(:request_handling_auth, @url, 'POST') do |request|
+              a_mock.a_message
+              raise NotAuthenticatedError.new
+            end
+          rescue NotAuthenticatedError => e
+          end
+        end
+
+        it 'should raise exception if retried more than 3 times' do
+          allow(@http_client).to receive (:request_access_token)
+          expect {
+            @http_client.send(:request_handling_auth, @url, 'POST') do |request|
+              raise NotAuthenticatedError.new
+            end
+          }.to raise_error
+        end
+      end
+    end
+  end
+
+  describe 'request_access_token' do
+
+    it 'should parse the response getting the accessToken entry' do
+      @http_client.send :request_access_token
+      expect(@http_client.instance_variable_get(:@access_token)).to eq 'SECRETTOKEN'
+    end
+  end
+
+  describe 'http_request' do
+
+    before do
+      @host = 'https://dev.livepaperapi.com/auth/token'
+      @http = double('Http mock')
+      allow(@http).to receive(:verify_mode=)
+      allow(@http).to receive(:use_ssl=)
+    end
+    it 'should create and return a Net::HTTP::Post instance if POST method is chosen.' do
+      expect(Net::HTTP::Post).to receive(:new).and_call_original
+      @http_client.send(:http_request, @host, 'POST')
+    end
+
+    it 'should create and return a Net::HTTP::Get instance if GET method is chosen.' do
+      expect(Net::HTTP::Get).to receive(:new).and_call_original
+      @http_client.send(:http_request, @host, 'GET')
+    end
+
+    it 'should use ssl' do
+      allow(Net::HTTP).to receive(:new).and_return(@http)
+      expect(@http).to receive(:use_ssl=)
+      @http_client.send(:http_request, @host, 'POST')
+    end
+
+    it 'should handle proxy settings' do
+      ENV['HTTP_PROXY'] = 'http://proxy.com:1234'
+      expect(Net::HTTP).to receive(:new).with('dev.livepaperapi.com', 443, 'proxy.com', '1234').and_return(@http)
+      @http_client.send(:http_request, @host, 'POST')
+    end
+
+    it 'should raise exception if the method provided is not supported.' do
+      expect { @http_client.send(:http_request, @host, 'NOT_SUPPORTED') }.to raise_error
+    end
+
+  end
+
+end