stannp 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff3ab1efdd21197064698fddde52daa93d9c4231d9d07ecc1d77be3e654c3d9
-  data.tar.gz: '059d4ec23e07c853a2c0134f2c0ecbecd05dc0ee174c2db538614f7954db24a1'
+  metadata.gz: e4fc37e08318f2d85aefc3cdcfedc1ce1a1f4656bfff9f40948113a8d99bd3f1
+  data.tar.gz: f219b6b64f689aac0861cfd752f886a0939db07953d3f1d0bdd3ed7a693222d4
 SHA512:
-  metadata.gz: c280a7cfb8cc8199ead8628cf599556e19ffd06298507630211e2a0e4c062a2f389bb54ecc010635e2fec148ebcdfcbecb09da9f5c3285097e2f6bd9bd609a08
-  data.tar.gz: 33ea9120a90755f163ad2b4597679da35c28b99d9a73550498259a558fb3b46d1efd582e434e586c7bf34afb4dcf9976bf7552ed2711bce7d9159277142a63c7
+  metadata.gz: d98546cd10f13d495414db820f987a018a020ff6027441785e4ae36a47e6e47354dbbf41c8cc0e869c38f52fea4763d0359adb4c482b5273187444fb8530d7a1
+  data.tar.gz: 50fa03eb79e9bc8fba16d52392382d7e7415253a7cd4c06a62fb4c6447611d8e06685a7a3b8bad2182392a33af0524e83e18790a34c9514013a38cff67e10a36

data/CHANGELOG.md

@@ -14,3 +14,12 @@
 
 ## [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
+
+## [0.8.0] - 2022-05-04
+- Add support for the Events API

data/lib/stannp/client.rb

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

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/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/events.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Stannp
+  class EventsResource < Resource
+    def create(attributes:)
+      url = url_for(path: 'recipientEvents/create')
+      post_request(url, body: attributes).body['data']
+    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/version.rb

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

data/lib/stannp.rb

@@ -15,6 +15,9 @@ module Stannp
   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'
+  autoload :EventsResource, 'stannp/resources/events'
   # objects
   autoload :User, 'stannp/objects/user'
   autoload :Recipient, 'stannp/objects/recipient'
@@ -22,4 +25,7 @@ module Stannp
   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.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - k-p-jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-16 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,6 +59,9 @@ files:
 - 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
@@ -67,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/events.rb
+- lib/stannp/resources/groups.rb
 - lib/stannp/resources/letters.rb
 - lib/stannp/resources/postcards.rb
 - lib/stannp/resources/recipients.rb