printreleaf 1.0.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31473a5421bed8c80fb386437d87d08f5f906b70
-  data.tar.gz: 05df26f63a70efdd9d4172aee42269f1e89d00d0
+  metadata.gz: ce4ddb5134037b5e6e8ef6b72cb3d04246496db5
+  data.tar.gz: c08337cccecfa720e7494f6d909764d59e99d91d
 SHA512:
-  metadata.gz: 241bdcde4a8f97a07a6552bb581d501b2c9b3a1643254219d82759586a819954b3146765c546c0e42932e12725692badc123c97300126222415b8a15343cdb5a
-  data.tar.gz: a75e0ddfc79c67aa7765583918126a053eb6cbccc1c695dd37875081e1461e7740fb5509bc9e32c1cf2386f8c6865e937dea93d133625eef0b824a32bf9f6045
+  metadata.gz: 3568602fd62af9953a709e24348a4e35688757a9564be6700e3a35d0da455e30919bfd15b0cf529f916e84be9bc5ebc44c72de691e56882ef5fea46e3dce742b
+  data.tar.gz: 7aac996128d1c6a01add24bf0081b41009f8353c3442015c2efc6924b84b4bceb7424a3f469b6f572a29fabcd202157724f318a70517f82ccf7683dd0741c5ab

data/README.md

@@ -54,11 +54,11 @@ account.users_count                 #=> 2
 account.mtd_pages                   #=> 1234
 account.qtd_pages                   #=> 12345
 account.ytd_pages                   #=> 123456
-account.lifetime_pages              #=> 1234567
+account.ltd_pages                   #=> 1234567
 account.mtd_trees                   #=> 0.15
 account.qtd_trees                   #=> 1.48
 account.ytd_trees                   #=> 14.82
-account.lifetime_trees              #=> 148.1
+account.ltd_trees                   #=> 148.1
 ```
 
 ### Listing Accounts
@@ -148,8 +148,8 @@ deposit = account.deposits.find("a86d591c-3c29-4bef-82c3-7a007fb6b19c") #=> #<Pr
 deposit.id            #=> "a86d591c-3c29-4bef-82c3-7a007fb6b19c"
 deposit.account_id    #=> "971d10ac-a912-42c0-aa41-f55adc7b6755"
 deposit.account       #=> #<PrintReleaf::Account>
-deposit.source_id     #=> "44e182ed-cd50-4fa1-af90-e77dd6d6a78c"
-deposit.source        #=> #<PrintReleaf::Source>
+deposit.feed_id     #=> "44e182ed-cd50-4fa1-af90-e77dd6d6a78c"
+deposit.feed        #=> #<PrintReleaf::Feed>
 deposit.date          #=> "2016-07-05T12:29:12Z"
 deposit.pages         #=> 20000
 deposit.width         #=> 0.2127
@@ -209,6 +209,64 @@ invitation.delete #=> true
 ```
 
 
+## Quotes
+
+### Listing Quotes
+
+```ruby
+PrintReleaf::Quote.list #=> [#<PrintReleaf::Quote>, #<PrintReleaf::Quote>]
+# -or-
+account.quotes #=> [#<PrintReleaf::Quote>, #<PrintReleaf::Quote>]
+```
+
+### Retrieving a Quote
+
+```ruby
+quote = PrintReleaf::Quote.find("83d12ee9-a187-489d-a93f-3096238f1f86") #=> #<PrintReleaf::Quote>
+# -or-
+quote = account.quotes.find("83d12ee9-a187-489d-a93f-3096238f1f86") #=> #<PrintReleaf::Quote>
+
+quote.id             #=> "83d12ee9-a187-489d-a93f-3096238f1f86"
+quote.account_id     #=> "971d10ac-a912-42c0-aa41-f55adc7b6755"
+quote.created_at     #=> "2015-10-22T01:52:12Z"
+quote.account        #=> #<PrintReleaf::Account>
+quote.transaction_id #=> "70af5540-e3ec-4db7-bc45-4fb65b74368b"
+quote.transaction    #=> #<PrintReleaf::Transaction>
+quote.trees          #=> 63.048
+quote.standard_pages #=> 525377
+quote.msrp_rate      #=> 0.0003
+quote.msrp_price     #=> 157.61
+quote.items          #=> [#<PrintReleaf::QuoteItem>, #<PrintReleaf::QuoteItem>]
+```
+
+### Creating a Quote
+
+```ruby
+quote = PrintReleaf::Quote.create(
+  items: [
+    {
+      quantity: 20000,
+      width: 0.2127,
+      height: 0.2762,
+      paper_type_id: "a11c7abc-011e-462f-babb-3c6375fa6473"
+    },
+    {
+      quantity: 400000,
+      width: 0.2127,
+      height: 0.2762,
+      paper_type_id: "bbd0f271-2f9e-494c-b2af-7f9354b310ad"
+    }
+  ]
+) #=> #<PrintReleaf::Quote>
+```
+
+### Deleting a Quote
+
+```ruby
+quote.delete #=> true
+```
+
+
 ## Servers
 
 ### Listing Servers
@@ -262,73 +320,73 @@ server.delete #=> true
 ```
 
 
-## Sources
+## Feeds
 
-### Listing Sources
+### Listing Feeds
 
 ```ruby
-PrintReleaf::Source.list #=> [#<PrintReleaf::Source>, #<PrintReleaf::Source>]
+PrintReleaf::Feed.list #=> [#<PrintReleaf::Feed>, #<PrintReleaf::Feed>]
 # -or-
-account.sources #=> [#<PrintReleaf::Source>, #<PrintReleaf::Source>]
+account.feeds #=> [#<PrintReleaf::Feed>, #<PrintReleaf::Feed>]
 ```
 
-### Retrieving a Source
+### Retrieving a Feed
 
 ```ruby
-source = PrintReleaf::Source.find("44e182ed-cd50-4fa1-af90-e77dd6d6a78c") #=> #<PrintReleaf::Source>
+feed = PrintReleaf::Feed.find("44e182ed-cd50-4fa1-af90-e77dd6d6a78c") #=> #<PrintReleaf::Feed>
 # -or-
-source = account.sources.find("44e182ed-cd50-4fa1-af90-e77dd6d6a78c") #=> #<PrintReleaf::Source>
+feed = account.feeds.find("44e182ed-cd50-4fa1-af90-e77dd6d6a78c") #=> #<PrintReleaf::Feed>
 
-source.id                      #=> "44e182ed-cd50-4fa1-af90-e77dd6d6a78c"
-source.account_id              #=> "971d10ac-a912-42c0-aa41-f55adc7b6755"
-source.account                 #=> #<PrintReleaf::Account>
-source.type                    #=> "fmaudit"
-source.server_id               #=> "eadabb78-b199-43cb-adbd-ab36ce5c5a10"
-source.server                  #=> #<PrintReleaf::Server>
-source.external_id             #=> "456"
-source.collection_scope        #=> "managed_only"
-source.created_at              #=> "2016-03-07T00:04:09Z"
-source.status                  #=> "active"
-source.activated_at            #=> "2016-03-07T00:04:09Z"
-source.deactivated_at          #=> nil
-source.health_check            #=> "healthy"
-source.health_check_checked_at #=> "2017-03-07T00:04:09Z"
-source.health_check_changed_at #=> "2017-03-07T00:04:09Z"
+feed.id                      #=> "44e182ed-cd50-4fa1-af90-e77dd6d6a78c"
+feed.account_id              #=> "971d10ac-a912-42c0-aa41-f55adc7b6755"
+feed.account                 #=> #<PrintReleaf::Account>
+feed.type                    #=> "fmaudit"
+feed.server_id               #=> "eadabb78-b199-43cb-adbd-ab36ce5c5a10"
+feed.server                  #=> #<PrintReleaf::Server>
+feed.external_id             #=> "456"
+feed.collection_scope        #=> "managed_only"
+feed.created_at              #=> "2016-03-07T00:04:09Z"
+feed.status                  #=> "active"
+feed.activated_at            #=> "2016-03-07T00:04:09Z"
+feed.deactivated_at          #=> nil
+feed.health_check            #=> "healthy"
+feed.health_check_checked_at #=> "2017-03-07T00:04:09Z"
+feed.health_check_changed_at #=> "2017-03-07T00:04:09Z"
 ```
 
-### Creating a Source
+### Creating a Feed
 
 ```ruby
-source = PrintReleaf::Source.create(
+feed = PrintReleaf::Feed.create(
   type: "printfleet",
   server_id: "9a6a1ced-4e71-4919-9d6d-25075834c404",
   external_id: "732ec0d3-20e3-439e-94e6-e64b40eb533a"
-) #=> #<PrintReleaf::Source>
+) #=> #<PrintReleaf::Feed>
 ```
 
-### Updating a Source
+### Updating a Feed
 
 ```ruby
-source.external_id = "abc123"
-source.save #=> true
+feed.external_id = "abc123"
+feed.save #=> true
 ```
 
-### Activating a Source
+### Activating a Feed
 
 ```ruby
-source.activate #=> true
+feed.activate #=> true
 ```
 
-### Deactivating a Source
+### Deactivating a Feed
 
 ```ruby
-source.deactivate #=> true
+feed.deactivate #=> true
 ```
 
-### Deleting a Source
+### Deleting a Feed
 
 ```ruby
-source.delete #=> true
+feed.delete #=> true
 ```
 
 
@@ -353,36 +411,28 @@ transaction.id             #=> "70af5540-e3ec-4db7-bc45-4fb65b74368b"
 transaction.account_id     #=> "971d10ac-a912-42c0-aa41-f55adc7b6755"
 transaction.account        #=> #<PrintReleaf::Account>
 transaction.project_id     #=> "692bb68d-64aa-4a79-8a08-d373fb0d8752"
-transaction.account        #=> #<PrintReleaf::Forestry::Project>
+transaction.project        #=> #<PrintReleaf::Forestry::Project>
 transaction.certificate_id #=> "70af5540-e3ec-4db7-bc45-4fb65b74368b"
-transaction.account        #=> #<PrintReleaf::Certificate>
+transaction.certificate    #=> #<PrintReleaf::Certificate>
+transaction.quote_id       #=> "83d12ee9-a187-489d-a93f-3096238f1f86"
+transaction.quote          #=> #<PrintReleaf::Quote>
 transaction.date           #=> "2015-10-22T01:52:12Z"
+transaction.pages          #=> 525377
 transaction.trees          #=> 63.048
-transaction.items          #=> [#<PrintReleaf::TransactionItem>, #<PrintReleaf::TransactionItem>]
 ```
 
 ### Creating a Transaction
 
 ```ruby
-# Providing only trees:
+# By providing total number of pages:
+transaction = PrintReleaf::Transaction.create(trees: 16000) #=> #<PrintReleaf::Transaction>
+
+# Or by providing total number of trees:
 transaction = PrintReleaf::Transaction.create(trees: 2.0) #=> #<PrintReleaf::Transaction>
 
-# or providing raw paper specs:
+# Or by providing a `quote_id` to convert a quote to a transaction
 transaction = PrintReleaf::Transaction.create(
-  items: [
-    {
-      pages: 20000,
-      width: 0.2127,
-      height: 0.2762,
-      paper_type_id: "a11c7abc-011e-462f-babb-3c6375fa6473"
-    },
-    {
-      pages: 400000,
-      width: 0.2127,
-      height: 0.2762,
-      paper_type_id: "bbd0f271-2f9e-494c-b2af-7f9354b310ad"
-    }
-  ]
+  quote_id: "83d12ee9-a187-489d-a93f-3096238f1f86"
 ) #=> #<PrintReleaf::Transaction>
 ```
 
@@ -518,7 +568,7 @@ PrintReleaf will raise exceptions for most failure scenarios, including invalid
 
 ```ruby
 begin
-  # Use PrintReleaf to make requests...
+  # Make requests...
 rescue PrintReleaf::RateLimitExceeded => e
   # Too many requests made to the API too quickly
 rescue PrintReleaf::BadRequest => e
@@ -561,5 +611,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/printr
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open feed under the terms of the [MIT License](http://openfeed.org/licenses/MIT).
 

data/lib/printreleaf.rb

@@ -23,10 +23,11 @@ require "printreleaf/paper/type"
 require "printreleaf/account"
 require "printreleaf/certificate"
 require "printreleaf/deposit"
+require "printreleaf/feed"
 require "printreleaf/invitation"
+require "printreleaf/quote_item"
+require "printreleaf/quote"
 require "printreleaf/server"
-require "printreleaf/source"
-require "printreleaf/transaction_item"
 require "printreleaf/transaction"
 require "printreleaf/user"
 require "printreleaf/volume_period"

data/lib/printreleaf/account.rb

@@ -23,11 +23,11 @@ module PrintReleaf
     property :mtd_pages,      transform_with: Transforms::Integer
     property :qtd_pages,      transform_with: Transforms::Integer
     property :ytd_pages,      transform_with: Transforms::Integer
-    property :lifetime_pages, transform_with: Transforms::Integer
+    property :ltd_pages,      transform_with: Transforms::Integer
     property :mtd_trees,      transform_with: Transforms::Float
     property :qtd_trees,      transform_with: Transforms::Float
     property :ytd_trees,      transform_with: Transforms::Float
-    property :lifetime_trees, transform_with: Transforms::Float
+    property :ltd_trees,      transform_with: Transforms::Float
 
     def self.mine
       response = PrintReleaf.get("/account")
@@ -72,6 +72,10 @@ module PrintReleaf
       @deposits ||= Relation.new(self, Deposit)
     end
 
+    def feeds
+      @feeds ||= Relation.new(self, Feed)
+    end
+
     def invitations
       @invitations ||= Relation.new(self, Invitation)
     end
@@ -80,10 +84,6 @@ module PrintReleaf
       @servers ||= Relation.new(self, Server)
     end
 
-    def sources
-      @sources ||= Relation.new(self, Source)
-    end
-
     def transactions
       @transactions ||= Relation.new(self, Transaction)
     end

data/lib/printreleaf/deposit.rb

@@ -9,7 +9,7 @@ module PrintReleaf
 
     property :id
     property :account_id
-    property :source_id
+    property :feed_id
     property :date, transform_with: Transforms::Date
     property :pages, transform_with: Transforms::Integer
     property :width, transform_with: Transforms::Float
@@ -21,9 +21,9 @@ module PrintReleaf
       @account ||= Account.find(account_id)
     end
 
-    def source
-      return nil if source_id.nil?
-      @source ||= Source.find(source_id)
+    def feed
+      return nil if feed_id.nil?
+      @feed ||= Feed.find(feed_id)
     end
 
     def paper_type

data/lib/printreleaf/{source.rb → feed.rb}

@@ -1,6 +1,6 @@
 module PrintReleaf
-  class Source < Resource
-    path "/sources"
+  class Feed < Resource
+    path "/feeds"
 
     action :find
     action :list

data/lib/printreleaf/quote.rb

@@ -0,0 +1,32 @@
+module PrintReleaf
+  class Quote < Resource
+    path "/quotes"
+
+    action :find
+    action :list
+    action :create
+    action :delete
+
+    property :id
+    property :account_id
+    property :project_id
+    property :transaction_id
+    property :created_at,     transform_with: Transforms::Date
+    property :standard_pages, transform_with: Transforms::Integer
+    property :trees,          transform_with: Transforms::Float
+    property :msrp_rate,      transform_with: Transforms::Float
+    property :msrp_price,     transform_with: Transforms::Float
+    property :items
+    coerce_key :items, Array[QuoteItem]
+
+    def account
+      @account ||= Account.find(account_id)
+    end
+
+    def transaction
+      return nil if transaction_id.nil?
+      @transaction ||= Transaction.find(transaction_id)
+    end
+  end
+end
+

data/lib/printreleaf/quote_item.rb

@@ -0,0 +1,15 @@
+module PrintReleaf
+  class QuoteItem < Resource
+    property :quantity, transform_with: Transforms::Integer
+    property :width,    transform_with: Transforms::Float
+    property :height,   transform_with: Transforms::Float
+    property :density,  transform_with: Transforms::Float
+    property :paper_type_id
+
+    def paper_type
+      return nil if paper_type_id.nil?
+      @paper_type ||= Paper::Type.find(paper_type_id)
+    end
+  end
+end
+

data/lib/printreleaf/transaction.rb

@@ -11,10 +11,10 @@ module PrintReleaf
     property :account_id
     property :project_id
     property :certificate_id
+    property :quote_id
     property :date, transform_with: Transforms::Date
+    property :pages, transform_with: Transforms::Integer
     property :trees, transform_with: Transforms::Float
-    property :items
-    coerce_key :items, Array[TransactionItem]
 
     def account
       @account ||= Account.find(account_id)
@@ -27,6 +27,11 @@ module PrintReleaf
     def certificate
       @certificate ||= Certificate.find(certificate_id)
     end
+
+    def quote
+      return nil if quote_id.nil?
+      @quote ||= Quote.find(quote_id)
+    end
   end
 end
 

data/lib/printreleaf/version.rb

@@ -1,3 +1,3 @@
 module PrintReleaf
-  VERSION = "1.0.3"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: printreleaf
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Casey O'Hara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-22 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -109,15 +109,16 @@ files:
 - lib/printreleaf/certificate.rb
 - lib/printreleaf/deposit.rb
 - lib/printreleaf/error.rb
+- lib/printreleaf/feed.rb
 - lib/printreleaf/forestry/project.rb
 - lib/printreleaf/invitation.rb
 - lib/printreleaf/paper/type.rb
+- lib/printreleaf/quote.rb
+- lib/printreleaf/quote_item.rb
 - lib/printreleaf/relation.rb
 - lib/printreleaf/resource.rb
 - lib/printreleaf/server.rb
-- lib/printreleaf/source.rb
 - lib/printreleaf/transaction.rb
-- lib/printreleaf/transaction_item.rb
 - lib/printreleaf/transforms.rb
 - lib/printreleaf/user.rb
 - lib/printreleaf/util.rb

data/lib/printreleaf/transaction_item.rb

@@ -1,15 +0,0 @@
-module PrintReleaf
-  class TransactionItem < Resource
-    property :pages, transform_with: Transforms::Integer
-    property :width, transform_with: Transforms::Float
-    property :height, transform_with: Transforms::Float
-    property :density, transform_with: Transforms::Float
-    property :paper_type_id
-
-    def paper_type
-      return nil if paper_type_id.nil?
-      @paper_type ||= Paper::Type.find(paper_type_id)
-    end
-  end
-end
-