stannp 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff3ab1efdd21197064698fddde52daa93d9c4231d9d07ecc1d77be3e654c3d9
-  data.tar.gz: '059d4ec23e07c853a2c0134f2c0ecbecd05dc0ee174c2db538614f7954db24a1'
+  metadata.gz: 2b75837b9841497a819ff0ecc1540b75cafa29b16694255447eaa214418a4d59
+  data.tar.gz: '021308c33f745ec2f9d82209fed48ae58c49055f88fa1a25762d1fae7973848c'
 SHA512:
-  metadata.gz: c280a7cfb8cc8199ead8628cf599556e19ffd06298507630211e2a0e4c062a2f389bb54ecc010635e2fec148ebcdfcbecb09da9f5c3285097e2f6bd9bd609a08
-  data.tar.gz: 33ea9120a90755f163ad2b4597679da35c28b99d9a73550498259a558fb3b46d1efd582e434e586c7bf34afb4dcf9976bf7552ed2711bce7d9159277142a63c7
+  metadata.gz: 90edcb56fa0374f3a1a18b80d442329d3631e42a2a751977e46eaf92d414a092dd6af72945f0a72b4de43c07d0b3f9fa09ae4fd7abffff7be6720f43c6e2e0e6
+  data.tar.gz: 44cb149dbea1d00ee6106aef2a45ace349c52b9a84ee332cbbe3bd24965abe815b513fb551e0ed97e5b30d1d6838d284cc04ec4b7b59c3dd1da380b5391fe71f

data/CHANGELOG.md

@@ -14,3 +14,6 @@
 
 ## [0.5.0] - 2022-04-16
 - Add support for the Letters API
+
+## [0.6.0] - 2022-04-21
+- Add support for the Groups API

data/lib/stannp/client.rb

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

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/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.6.0'
 end

data/lib/stannp.rb

@@ -15,6 +15,7 @@ module Stannp
   autoload :AddressesResource, 'stannp/resources/addresses'
   autoload :PostcardsResource, 'stannp/resources/postcards'
   autoload :LettersResource, 'stannp/resources/letters'
+  autoload :GroupsResource, 'stannp/resources/groups'
   # objects
   autoload :User, 'stannp/objects/user'
   autoload :Recipient, 'stannp/objects/recipient'
@@ -22,4 +23,5 @@ module Stannp
   autoload :Postcard, 'stannp/objects/postcard'
   autoload :Letter, 'stannp/objects/letter'
   autoload :Batch, 'stannp/objects/batch'
+  autoload :Group, 'stannp/objects/group'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stannp
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - k-p-jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-16 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -59,6 +59,7 @@ files:
 - lib/stannp/list.rb
 - lib/stannp/object.rb
 - lib/stannp/objects/batch.rb
+- lib/stannp/objects/group.rb
 - lib/stannp/objects/letter.rb
 - lib/stannp/objects/postcard.rb
 - lib/stannp/objects/receipt.rb
@@ -67,6 +68,7 @@ files:
 - lib/stannp/resource.rb
 - lib/stannp/resources/account.rb
 - lib/stannp/resources/addresses.rb
+- lib/stannp/resources/groups.rb
 - lib/stannp/resources/letters.rb
 - lib/stannp/resources/postcards.rb
 - lib/stannp/resources/recipients.rb