stannp 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfc91d10039a3c87a7c4e8725a764dce523dd9f26ff814a20a39757bdb86108d
-  data.tar.gz: 153a1c9b0a9a6fc9cfc23a4fa630ba144a01712027dc4f39865199c5eb463875
+  metadata.gz: 2b75837b9841497a819ff0ecc1540b75cafa29b16694255447eaa214418a4d59
+  data.tar.gz: '021308c33f745ec2f9d82209fed48ae58c49055f88fa1a25762d1fae7973848c'
 SHA512:
-  metadata.gz: 5a8c1c3a9047377908c0726dac92833007c367816d0683deed3fec3d92bc5f468b9c2b17bc957501f334f53c7ca57e7bd1d1cf8d834ecb2beac627492ec4d9fb
-  data.tar.gz: 992bb70c57042c83ca701a34cfb4cb843fe4f34484ee27d3eb4ff08196d980324d58dd536e05705edd4ddb23320a0a5aa2f52e2a12d87e1e34eb4d922e9b20bf
+  metadata.gz: 90edcb56fa0374f3a1a18b80d442329d3631e42a2a751977e46eaf92d414a092dd6af72945f0a72b4de43c07d0b3f9fa09ae4fd7abffff7be6720f43c6e2e0e6
+  data.tar.gz: 44cb149dbea1d00ee6106aef2a45ace349c52b9a84ee332cbbe3bd24965abe815b513fb551e0ed97e5b30d1d6838d284cc04ec4b7b59c3dd1da380b5391fe71f

data/CHANGELOG.md

@@ -8,3 +8,12 @@
 ## [0.3.0] - 2022-04-11
 - Add support for recipient upload
 - Add the Addresses API
+
+## [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

data/lib/stannp/client.rb

@@ -5,6 +5,7 @@ require 'faraday_middleware'
 
 module Stannp
   class Client
+    BASE_URL = 'https://dash.stannp.com/api/v1'
     attr_reader :api_key, :adapter
 
     def initialize(api_key:, adapter: Faraday.default_adapter, stubs: nil)
@@ -29,8 +30,21 @@ module Stannp
       AddressesResource.new(client: self)
     end
 
+    def postcards
+      PostcardsResource.new(client: self)
+    end
+
+    def letters
+      LettersResource.new(client: self)
+    end
+
+    def groups
+      GroupsResource.new(client: self)
+    end
+
     def connection
       @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
         conn.request :json
         conn.response :json, content_type: 'application/json'
         conn.adapter adapter, stubs

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/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/objects/postcard.rb

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

data/lib/stannp/resource.rb

@@ -14,6 +14,16 @@ module Stannp
       handle_response client.connection.post(url, body, headers)
     end
 
+    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
 
     attr_reader :client

data/lib/stannp/resources/account.rb

@@ -3,12 +3,12 @@
 module Stannp
   class AccountResource < Resource
     def balance
-      url = "https://dash.stannp.com/api/v1/accounts/balance?api_key=#{client.api_key}}"
+      url = url_for(path: 'accounts/balance')
       get_request(url).body['data']['balance']
     end
 
     def top_up(amount:)
-      url = "https://dash.stannp.com/api/v1/accounts/topup?api_key=#{client.api_key}}"
+      url = url_for(path: 'accounts/topup')
       url = post_request(url, body: { net: amount.to_f.to_s }).body['data']['receipt_pdf']
       Stannp::Receipt.new(url: url)
     end

data/lib/stannp/resources/addresses.rb

@@ -3,7 +3,7 @@
 module Stannp
   class AddressesResource < Resource
     def validate(attributes:)
-      url = "https://dash.stannp.com/api/v1/addresses/validate?api_key=#{client.api_key}"
+      url = url_for(path: 'addresses/validate')
       post_request(url, body: attributes).body['data']['is_valid']
     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/resources/postcards.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Stannp
+  class PostcardsResource < Resource
+    def create(attributes:)
+      url = url_for(path: 'postcards/create')
+      Postcard.new(post_request(url, body: attributes).body['data'])
+    end
+
+    def get(id:)
+      url = url_for(path: "postcards/get/#{id}")
+      Postcard.new(get_request(url).body['data'])
+    end
+
+    def cancel(id:)
+      url = url_for(path: 'postcards/cancel')
+      post_request(url, body: { id: id }).body['success']
+    end
+  end
+end

data/lib/stannp/resources/recipients.rb

@@ -4,28 +4,28 @@ module Stannp
   class RecipientsResource < Resource
     def list(group_id: nil)
       id = group_id ? "/#{group_id}" : ''
-      url = "https://dash.stannp.com/api/v1/recipients/list#{id}?api_key=#{client.api_key}"
+      url = url_for(path: "recipients/list#{id}")
       List.from_request(data: get_request(url).body['data'], type: Recipient)
     end
 
     def get(id:)
-      url = "https://dash.stannp.com/api/v1/recipients/get/#{id}?api_key=#{client.api_key}"
+      url = url_for(path: "recipients/get/#{id}")
       Recipient.new(get_request(url).body['data'])
     end
 
     def create(attributes:)
-      url = "https://dash.stannp.com/api/v1/recipients/new?api_key=#{client.api_key}"
+      url = url_for(path: 'recipients/new')
       Recipient.new(post_request(url, body: attributes).body['data'])
     end
 
     def delete(id:)
-      url = "https://dash.stannp.com/api/v1/recipients/delete?api_key=#{client.api_key}"
+      url = url_for(path: 'recipients/delete')
       post_request(url, body: { id: id.to_i })
       true
     end
 
     def delete_all
-      url = "https://dash.stannp.com/api/v1/recipients/deleteAll?api_key=#{client.api_key}"
+      url = url_for(path: 'recipients/deleteAll')
       post_request(url, body: { delete_all: true })
       true
     rescue Stannp::Error => e
@@ -37,7 +37,7 @@ module Stannp
     end
 
     def import(group_id:, file:, options: {})
-      url = "https://dash.stannp.com/api/v1/recipients/import?api_key=#{client.api_key}"
+      url = url_for(path: 'recipients/import')
       body = { group_id: group_id, file: file }.merge(options)
       post_request(url, body: body).body['success']
     end

data/lib/stannp/resources/user.rb

@@ -3,7 +3,7 @@
 module Stannp
   class UserResource < Resource
     def get
-      url = "https://dash.stannp.com/api/v1/users/me?api_key=#{client.api_key}"
+      url = url_for(path: 'users/me')
       User.new(get_request(url).body['data'])
     end
   end

data/lib/stannp/version.rb

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

data/lib/stannp.rb

@@ -13,8 +13,15 @@ module Stannp
   autoload :UserResource, 'stannp/resources/user'
   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'
   # 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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stannp
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - k-p-jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,12 +58,19 @@ files:
 - lib/stannp/error.rb
 - 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
 - lib/stannp/objects/recipient.rb
 - lib/stannp/objects/user.rb
 - 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
 - lib/stannp/resources/user.rb
 - lib/stannp/version.rb