stannp 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5cf8e8da25fd4bf0f3130533712a0d1a71e6d7cc9187b47fd9fc4643e5856cc
-  data.tar.gz: 8cbc6fd50818dbf95b2ffc7f34ec2e71d81b90b70cd81873a5c23a8d9f2d0f1e
+  metadata.gz: 9e29851d6d5a2f08247c7840729b21d9da1db101165deae90e43560fabd6db13
+  data.tar.gz: 258c841164c6abd4312f156252b9087e6fdc75f55708d874dd99e82d7cf223f8
 SHA512:
-  metadata.gz: ceb18058cc55aa19e3a69ef61ddc50dbc40186fe511b0ece19194cc3f3e13ccb21c02f85bd48b6ceb1224659ef23df0ca2fc97491a0bd7124239333d4c870db7
-  data.tar.gz: 65ebaea8d56f197e89a8e4bdb4d29c46444dcb6c03541da765e8b7932514771b800ea4bd6895e77ac18ad5dcad9184fa683a8a298804d314658d2a5d47182cf0
+  metadata.gz: '0800d2c215fb73f6f5d559a5e1bd1ff4cc8025cdedd61d452088adc4efa5288c7221a7a35733d5a1a046e9fd96f1cf4f8527d793676560bbca6bedd1602f386b'
+  data.tar.gz: 0b92c7ad6ae8f5d6dba704d85c6827e4f9aadd6e10ca9d5a4f5426e963465becc637f411bb2567b790e304d9b7d86f5a3180371c40c17c7b4c2e36f1c8e85618

data/CHANGELOG.md

@@ -11,3 +11,12 @@
 
 ## [0.4.0] - 2022-04-16
 - Add support for the Postcards API
+
+## [0.5.0] - 2022-04-16
+- Add support for the Letters API
+
+## [0.6.0] - 2022-04-21
+- Add support for the Groups API
+
+## [0.7.0] - 2022-04-22
+- Add support for the Campaigns API

data/lib/stannp/client.rb

@@ -34,6 +34,18 @@ module Stannp
       PostcardsResource.new(client: self)
     end
 
+    def letters
+      LettersResource.new(client: self)
+    end
+
+    def groups
+      GroupsResource.new(client: self)
+    end
+
+    def campaigns
+      CampaignsResource.new(client: self)
+    end
+
     def connection
       @connection ||= Faraday.new do |conn|
         conn.url_prefix = BASE_URL

data/lib/stannp/objects/batch.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class Batch < Object; end
+end

data/lib/stannp/objects/campaign.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class Campaign < Object; end
+end

data/lib/stannp/objects/campaign_cost.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class CampaignCost < Object; end
+end

data/lib/stannp/objects/group.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class Group < Object; end
+end

data/lib/stannp/objects/letter.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class Letter < Object; end
+end

data/lib/stannp/resource.rb

@@ -14,8 +14,14 @@ module Stannp
       handle_response client.connection.post(url, body, headers)
     end
 
-    def url_for(path:)
-      "#{path}?api_key=#{client.api_key}"
+    def url_for(path:, params: nil)
+      url = "#{path}?api_key=#{client.api_key}"
+      params&.each do |k, v|
+        next unless v
+
+        url += "&#{k}=#{v}"
+      end
+      url
     end
 
     private

data/lib/stannp/resources/campaigns.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Stannp
+  class CampaignsResource < Resource
+    def list
+      url = url_for(path: 'campaigns/list')
+      List.from_request(data: get_request(url).body['data'], type: Campaign)
+    end
+
+    def get(id:)
+      url = url_for(path: "campaigns/get/#{id}")
+      Campaign.new(get_request(url).body['data'])
+    end
+
+    def cost(id:)
+      url = url_for(path: 'campaigns/cost')
+      CampaignCost.new(post_request(url, body: { id: id }).body['data'])
+    end
+
+    def available_booking_dates(start_date: nil, end_date: nil)
+      url = url_for(path: 'campaigns/availableDates')
+      post_request(url, body: { start: start_date, end: end_date }).body['data']
+    end
+
+    def create(attributes:)
+      url = url_for(path: 'campaigns/create')
+      Campaign.new(id: post_request(url, body: attributes).body['data'])
+    end
+
+    def sample_url(id:)
+      url = url_for(path: 'campaigns/sample')
+      post_request(url, body: { id: id }).body['data']
+    end
+
+    def approve(id:)
+      url = url_for(path: 'campaigns/approve')
+      post_request(url, body: { id: id }).body['success']
+    end
+
+    def delete(id:)
+      url = url_for(path: 'campaigns/delete')
+      post_request(url, body: { id: id }).body['success']
+    end
+
+    def book(id:, **options)
+      url = url_for(path: 'campaigns/book')
+      post_request(url, body: { id: id }.merge(options)).body['success']
+    end
+  end
+end

data/lib/stannp/resources/groups.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Stannp
+  class GroupsResource < Resource
+    def list(offset: nil, limit: nil)
+      params = { offset: offset, limit: limit }
+      url = url_for(path: 'groups/list', params: params)
+      List.from_request(data: get_request(url).body['data'], type: Group)
+    end
+
+    def create(name:)
+      url = url_for(path: 'groups/new')
+      Group.new(post_request(url, body: { name: name }).body['data'])
+    end
+
+    def add_recipients(id:, recipient_ids:)
+      url = url_for(path: "groups/add/#{id}")
+      ids = recipient_ids.is_a?(Array) ? recipient_ids.join(',') : recipient_ids
+      post_request(url, body: { recipients: ids }).body['success']
+    end
+
+    def remove_recipients(id:, recipient_ids:)
+      url = url_for(path: "groups/remove/#{id}")
+      ids = recipient_ids.is_a?(Array) ? recipient_ids.join(',') : recipient_ids
+      post_request(url, body: { recipients: ids }).body['success']
+    end
+
+    def delete(id:)
+      url = url_for(path: "groups/delete/#{id}")
+      post_request(url, body: { id: id }).body['success']
+    end
+
+    def purge(id:, delete_recipients: false)
+      url = url_for(path: "groups/purge/#{id}")
+      post_request(url, body: { id: id, delete_recipients: delete_recipients }).body['success']
+    end
+  end
+end

data/lib/stannp/resources/letters.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Stannp
+  class LettersResource < Resource
+    def create(attributes:)
+      url = url_for(path: 'letters/create')
+      Letter.new(post_request(url, body: attributes).body['data'])
+    end
+
+    def post(attributes:)
+      url = url_for(path: 'letters/post')
+      Letter.new(post_request(url, body: attributes).body['data'])
+    end
+
+    def get(id:)
+      url = url_for(path: "letters/get/#{id}")
+      Letter.new(get_request(url).body['data'])
+    end
+
+    def cancel(id:)
+      url = url_for(path: 'letters/cancel')
+      post_request(url, body: { id: id }).body['success']
+    end
+
+    def batch(attributes:)
+      url = url_for(path: 'letters/batch')
+      Batch.new(post_request(url, body: attributes).body['data'])
+    end
+  end
+end

data/lib/stannp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stannp
-  VERSION = '0.4.0'
+  VERSION = '0.7.0'
 end

data/lib/stannp.rb

@@ -14,9 +14,17 @@ module Stannp
   autoload :RecipientsResource, 'stannp/resources/recipients'
   autoload :AddressesResource, 'stannp/resources/addresses'
   autoload :PostcardsResource, 'stannp/resources/postcards'
+  autoload :LettersResource, 'stannp/resources/letters'
+  autoload :GroupsResource, 'stannp/resources/groups'
+  autoload :CampaignsResource, 'stannp/resources/campaigns'
   # objects
   autoload :User, 'stannp/objects/user'
   autoload :Recipient, 'stannp/objects/recipient'
   autoload :Receipt, 'stannp/objects/receipt'
   autoload :Postcard, 'stannp/objects/postcard'
+  autoload :Letter, 'stannp/objects/letter'
+  autoload :Batch, 'stannp/objects/batch'
+  autoload :Group, 'stannp/objects/group'
+  autoload :Campaign, 'stannp/objects/campaign'
+  autoload :CampaignCost, 'stannp/objects/campaign_cost'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stannp
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - k-p-jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-16 00:00:00.000000000 Z
+date: 2022-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,6 +58,11 @@ files:
 - lib/stannp/error.rb
 - lib/stannp/list.rb
 - lib/stannp/object.rb
+- lib/stannp/objects/batch.rb
+- lib/stannp/objects/campaign.rb
+- lib/stannp/objects/campaign_cost.rb
+- lib/stannp/objects/group.rb
+- lib/stannp/objects/letter.rb
 - lib/stannp/objects/postcard.rb
 - lib/stannp/objects/receipt.rb
 - lib/stannp/objects/recipient.rb
@@ -65,6 +70,9 @@ files:
 - lib/stannp/resource.rb
 - lib/stannp/resources/account.rb
 - lib/stannp/resources/addresses.rb
+- lib/stannp/resources/campaigns.rb
+- lib/stannp/resources/groups.rb
+- lib/stannp/resources/letters.rb
 - lib/stannp/resources/postcards.rb
 - lib/stannp/resources/recipients.rb
 - lib/stannp/resources/user.rb