live_paper 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d263eee26996dd3f13c1da9e6a248febe38254e
-  data.tar.gz: fb769ff8007deab3c6fc2be5ebae3f883993d8fd
+  metadata.gz: 55487ee90d033af97fe99a9bee4d5c94795c47a5
+  data.tar.gz: 69687e92cfae6cb80b658e332213624ab86dc264
 SHA512:
-  metadata.gz: 2125d2363ff676e2de5b7b1d2a0e08b4f718883a6f4f6238ed974500b56c566ca422ed1461e6e238629fb81ef020282f4568a46ee6aeb4c4efc87a9cddd9dd50
-  data.tar.gz: 6df54c047f502e725096e876a964b6ec528a127544b059cd1fd5e7576e7aff1809aa6ecd305694e4c138902c8f3591d07b74cf42bd479ed75017adae2dc16b01
+  metadata.gz: b683e8714f1d051c52df36ebc70c4ca83e5b8698eb507fef2de071a81f8fa0846520e238dee464884f2667b99c2a5c07eaf8fe5f881176171b6268deb9e77cac
+  data.tar.gz: 68854880dcfe91eda7b7b6eebc10fa3ce27673ad02609e54530b51060946ff2e3fda213bfe75f13ef8a997b286ade2c86382c2eedccf24d717b455c8144f521d

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 
 In order to generate access credentials, register here:  https://www.linkcreationstudio.com
 
-## Usage
+## Quick-Start Usage
 
 ### Authenticate
 
@@ -58,6 +58,91 @@ File.open("watermark.jpg", "w:UTF-8") { |f| f.write(wm_bytes.force_encoding("UTF
 
 > Note: Version 1 of the API only supports returning image bytes. Version 2 may host publicly accessible images.
 
+## Usage
+
+The gem supports full CRUD operations on the underlying objects. If you do not need to update or
+delete previously created objects, see the quick-start section above.
+
+### Underlying Objects
+
+**Triggers** represent the object you want to put on a page: a short url, QR code, or watermarked image.
+**Payoffs** are destinations, either the url of a webpage, or an interactive mobile experience.
+**Links** join a Trigger to a Payoff.
+
+### CRUD Example
+
+```ruby
+  lp = LivePaper.auth({id: "your client id", secret: "your client secret"})
+
+  t=ShortTrigger.create(name: 'short trigger')
+  p=Payoff.create(name: 'name', type: Payoff::TYPE[:WEB], url: "http://www.hp.com")
+  l=Link.create(payoff_id: p.id, trigger_id: t.id, name: "link")
+  @link_id=l.id
+  @payoff_id=p.id
+  @trigger_id=t.id
+  t.short_url # returns url of the form http://hpgo.co/abc123
+```
+
+After creating, you will need to persist the link, payoff, and trigger IDs in some form of
+permanent storage to later access the resources. The IDs are strings.
+
+If you want to change the destination:
+
+```ruby
+  lp = LivePaper.auth({id: "your client id", secret: "your client secret"})
+
+  p=Payoff.get(@payoff_id)
+  p.url="http://shopping.hp.com"
+  p.update
+```
+
+Still later, if you wanted to delete the resources:
+
+```ruby
+  lp = LivePaper.auth({id: "your client id", secret: "your client secret"})
+
+  # delete link first, to avoid resource conflict
+  l=Link.get(@link_id)
+  l.delete
+
+  t=Trigger.get(@trigger_id)
+  t.delete
+
+  p=Payoff.get(@payoff_id)
+  p.delete
+```
+
+You can list existing resources with the list operation.
+
+```ruby
+  lp = LivePaper.auth({id: "your client id", secret: "your client secret"})
+
+  @links=Link.list # returns array of Link objects
+
+  @payoffs=Payoff.list # returns array of Payoff objects
+```
+
+### QR Code Example
+
+```ruby
+  t=QrTrigger.create(name: 'QR code trigger')
+  p=Payoff.create(name: 'name', type: Payoff::TYPE[:WEB], url: "http://www.hp.com")
+  l=Link.create(payoff_id: p.id, trigger_id: t.id, name: "link")
+  t.download_qrcode # returns QR image bytes
+```
+
+### Watermarked Image Example
+
+```ruby
+  image = Image.upload "http://url/to_your_image"
+
+  t=WmTrigger.create(name: 'watermark', watermark: {strength: 10, resolution: 75, imageURL: image})
+  p=Payoff.create(name: 'name', type: Payoff::TYPE[:WEB], url: dest)
+  l=Link.create(payoff_id: p.id, trigger_id: t.id, name: "link")
+  t.download_watermark
+```
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/IPGPTP/live_paper/fork )

data/lib/live_paper/base_object.rb

@@ -49,7 +49,6 @@ module LivePaper
     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|
@@ -59,7 +58,6 @@ module LivePaper
                                              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
@@ -163,4 +161,4 @@ module LivePaper
       raise NotImplementedError
     end
   end
-end
+end

data/lib/live_paper/version.rb

@@ -1,3 +1,3 @@
 module LivePaper
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: live_paper
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Mike Whitmarsh
@@ -9,76 +9,76 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-08 00:00:00.000000000 Z
+date: 2014-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby interface to use the Live Paper service by HP for creating watermarked
@@ -88,7 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -123,12 +123,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []