stannp 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59a7326c7fc932044cc7706a6e13769012cc269b253efa3ec51dae2b7c2517ea
-  data.tar.gz: f5cb65cc496bbe21d4657a65053af6518fc812a573590648a5ccb2949e23ce02
+  metadata.gz: bff3ab1efdd21197064698fddde52daa93d9c4231d9d07ecc1d77be3e654c3d9
+  data.tar.gz: '059d4ec23e07c853a2c0134f2c0ecbecd05dc0ee174c2db538614f7954db24a1'
 SHA512:
-  metadata.gz: cb4f1277029da2883fc36eea3e5ba72ba7b61d29fe10580f69d98894669952d6581d3208933d5c1ef67934a14ec4881ec194776e83e2a617da1930bb964466c4
-  data.tar.gz: 882d0899a9beaaf8877bf944645e76fe3f32c208630da4700e5b4aa7dc26a5a02e0e7c5cbab0aa6b2f98379cc77117ce5a27cd72ef220b98307946b27d5da846
+  metadata.gz: c280a7cfb8cc8199ead8628cf599556e19ffd06298507630211e2a0e4c062a2f389bb54ecc010635e2fec148ebcdfcbecb09da9f5c3285097e2f6bd9bd609a08
+  data.tar.gz: 33ea9120a90755f163ad2b4597679da35c28b99d9a73550498259a558fb3b46d1efd582e434e586c7bf34afb4dcf9976bf7552ed2711bce7d9159277142a63c7

data/CHANGELOG.md

@@ -4,3 +4,13 @@
 
 ## [0.2.0] - 2022-04-11
 - Add support for the complete Account API
+
+## [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

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)
@@ -25,8 +26,21 @@ module Stannp
       RecipientsResource.new(client: self)
     end
 
+    def addresses
+      AddressesResource.new(client: self)
+    end
+
+    def postcards
+      PostcardsResource.new(client: self)
+    end
+
+    def letters
+      LettersResource.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/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,12 +14,8 @@ module Stannp
       handle_response client.connection.post(url, body, headers)
     end
 
-    def patch_request(url, body:, headers: {})
-      handle_response client.connection.patch(url, body, headers)
-    end
-
-    def put_request(url, body:, headers: {})
-      handle_response client.connection.put(url, body, headers)
+    def url_for(path:)
+      "#{path}?api_key=#{client.api_key}"
     end
 
     private

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Stannp
+  class AddressesResource < Resource
+    def validate(attributes:)
+      url = url_for(path: 'addresses/validate')
+      post_request(url, body: attributes).body['data']['is_valid']
+    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
@@ -35,5 +35,11 @@ module Stannp
 
       raise e
     end
+
+    def import(group_id:, file:, options: {})
+      url = url_for(path: 'recipients/import')
+      body = { group_id: group_id, file: file }.merge(options)
+      post_request(url, body: body).body['success']
+    end
   end
 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.2.0'
+  VERSION = '0.5.0'
 end

data/lib/stannp.rb

@@ -12,8 +12,14 @@ module Stannp
   autoload :AccountResource, 'stannp/resources/account'
   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'
   # 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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stannp
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - k-p-jones
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-11 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -58,11 +58,17 @@ files:
 - lib/stannp/error.rb
 - lib/stannp/list.rb
 - lib/stannp/object.rb
+- lib/stannp/objects/batch.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/letters.rb
+- lib/stannp/resources/postcards.rb
 - lib/stannp/resources/recipients.rb
 - lib/stannp/resources/user.rb
 - lib/stannp/version.rb