stannp 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df463198452eace393468c01970f5a2d5f0aca063bfebd9e98a059b006525e66
-  data.tar.gz: c0e810b647919ca53513ccb0d35010aeb5afeed348a2c2325d2cdde4ed658fd3
+  metadata.gz: d5cf8e8da25fd4bf0f3130533712a0d1a71e6d7cc9187b47fd9fc4643e5856cc
+  data.tar.gz: 8cbc6fd50818dbf95b2ffc7f34ec2e71d81b90b70cd81873a5c23a8d9f2d0f1e
 SHA512:
-  metadata.gz: f84d3718a853fda778d709769141be754c250f99ee65de980307a98fbf1133b7b68f2d9e8b568007aaf9a4c88684189f38f9714002b6d50ea4c6ba58fc40c1ca
-  data.tar.gz: 7a5a4e153c5822dcac9888b98bf7560ea7c76895f88fe0df5022596ff4edbe1667a5d09413916370f138b1e80f84bbb53a4944c973248a0fea6ea6f54cb7299f
+  metadata.gz: ceb18058cc55aa19e3a69ef61ddc50dbc40186fe511b0ece19194cc3f3e13ccb21c02f85bd48b6ceb1224659ef23df0ca2fc97491a0bd7124239333d4c870db7
+  data.tar.gz: 65ebaea8d56f197e89a8e4bdb4d29c46444dcb6c03541da765e8b7932514771b800ea4bd6895e77ac18ad5dcad9184fa683a8a298804d314658d2a5d47182cf0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
-## [Unreleased]
+## [0.1.0] - 2022-04-10
+- Add the Recipients API
+- Add the User API
 
-## [0.1.0] - 2022-04-09
+## [0.2.0] - 2022-04-11
+- Add support for the complete Account API
 
-- Initial release
+## [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

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,17 @@ module Stannp
       RecipientsResource.new(client: self)
     end
 
+    def addresses
+      AddressesResource.new(client: self)
+    end
+
+    def postcards
+      PostcardsResource.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/postcard.rb

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

data/lib/stannp/objects/receipt.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Stannp
+  class Receipt < 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,8 +3,14 @@
 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 = 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
   end
 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/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.1.0'
+  VERSION = '0.4.0'
 end

data/lib/stannp.rb

@@ -12,7 +12,11 @@ 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'
   # objects
   autoload :User, 'stannp/objects/user'
   autoload :Recipient, 'stannp/objects/recipient'
+  autoload :Receipt, 'stannp/objects/receipt'
+  autoload :Postcard, 'stannp/objects/postcard'
 end

metadata

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