seeuletter 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -1
  3. data/examples/invoices.rb +8 -3
  4. data/examples/postcards.rb +53 -0
  5. data/lib/seeuletter/client.rb +9 -3
  6. data/lib/seeuletter/resources/postcard.rb +14 -0
  7. data/lib/seeuletter/resources/resource_base.rb +1 -1
  8. data/lib/seeuletter/version.rb +1 -1
  9. metadata +4 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4ae03460189501286ccadd04b8fed5ec5cbaf1fc457b550f0ca559fc655450f0
4
- data.tar.gz: e8b36e0d48592e84e60456c9870956a84f85dabd618a8654e6de491925460f97
3
+ metadata.gz: 8d8f0ef5ad1a4a5fa1ecc2e9b8bb884c69bf7b7cafc404d9d4e5396315a1031c
4
+ data.tar.gz: 3bd27cfff44dad93249b43c4b41cfdfc623fff5040e8ff5da5cb6629ebfc5dde
5
5
  SHA512:
6
- metadata.gz: 0ab2e688c5ca19522f28cc73a601d2772290f8be0ae9e1777a1fd833b45a65c0335ef94723324ee78db793a3f2de4e4b2503036a162372d6c28907127d99e535
7
- data.tar.gz: 5b9c39c72c7cd3bdf39f30d445ecd6eb2a15fd898f5ca05bd838b0aed6b8f4ee1560f92d07b1170fb10488dccb84fed59a6f1f92e054241c99ad8facd9935eb0
6
+ metadata.gz: e705d29c734418ae29105a320286e0cc127957126b9b27e591d2b4567eade43d64dc00af7da3b09872475e082f24506fabbab1e64b82caa2f4965a90050e8365
7
+ data.tar.gz: 44202bd632ea59fdd7217d89ba05279f9f1eadb4b986ebd0f41e1884acc26fbff1ecbddd3744afa543604fb93c2fe91c8af7f5ca3a2c4efc26669309bb08cbcf
data/README.md CHANGED
@@ -59,6 +59,11 @@ For optional parameters and other details, refer to the docs [here](https://docs
59
59
  seeuletter = Seeuletter::Client.new(api_key: "your-api-key")
60
60
  ```
61
61
 
62
+ ```ruby
63
+ # To initialize a Seeuletter object configured with non default host api
64
+ seeuletter = Seeuletter::Client.new(api_key: "your-api-key", host: "127.0.0.1")
65
+ ```
66
+
62
67
  ### Letters
63
68
 
64
69
  #### Create a new letter
@@ -227,6 +232,6 @@ There are simple scripts to demonstrate how to create all letters with the Seeul
227
232
 
228
233
  =======================
229
234
 
230
- Copyright © 2017 Seeuletter.com
235
+ Copyright © 2024 Seeuletter.com
231
236
 
232
237
  Released under the MIT License, which can be found in the repository in `LICENSE.txt`.
data/examples/invoices.rb CHANGED
@@ -12,9 +12,14 @@ begin
12
12
  )
13
13
  puts "The Seeuletter API Invoices responded : #{list_response}"
14
14
 
15
- # get single invoice by API
16
- find_response = seeuletter.invoices.find(list_response['invoices'][0]['_id'])
17
- puts "The Seeuletter API Invoice responded : #{find_response}"
15
+ if list_response['invoices'].count > 0
16
+ # get single invoice by API
17
+ find_response = seeuletter.invoices.find(list_response['invoices'][0]['_id'])
18
+ puts "The Seeuletter API Invoice responded : #{find_response}"
19
+ else
20
+ # no invoice to get by API
21
+ puts "No invoice can be found"
22
+ end
18
23
 
19
24
  rescue Seeuletter::SeeuletterError => ex
20
25
  puts "Error from API : #{ex}"
data/examples/postcards.rb ADDED
@@ -0,0 +1,53 @@
1
+ # frozen_string_literal: true
2
+
3
+ $LOAD_PATH.unshift File.expand_path('../lib', File.dirname(__FILE__))
4
+ require 'seeuletter'
5
+
6
+ # initialize Seeuletter object
7
+ seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
8
+
9
+ html = %(
10
+ <html>
11
+ <head>
12
+ <style>
13
+ *, *:before, *:after {
14
+ -webkit-box-sizing: border-box;
15
+ -moz-box-sizing: border-box;
16
+ box-sizing: border-box;
17
+ }
18
+ .text {
19
+ margin-left: 50px;
20
+ padding-top: 450px;
21
+ font-size: 50px;
22
+ font-weight: 700;
23
+ }
24
+ </style>
25
+ </head>
26
+
27
+ <body>
28
+ <p class="text">Hello {{name}}!</p>
29
+ </body>
30
+
31
+ </html>
32
+ )
33
+
34
+ # list all postcards sent
35
+ puts seeuletter.postcards.list
36
+
37
+ # send a dummy the letter
38
+ puts seeuletter.postcards.create(
39
+ description: 'Test letter from the Ruby Wrapper',
40
+ to: {
41
+ name: 'Erlich',
42
+ address_line1: '30 rue de rivoli',
43
+ address_line2: '',
44
+ address_city: 'Paris',
45
+ address_country: 'France',
46
+ address_postalcode: '75004'
47
+ },
48
+ source_file_front: html,
49
+ source_file_front_type: 'html',
50
+ source_file_back: html,
51
+ source_file_back_type: 'html',
52
+ variables: { name: 'Erlich' }
53
+ )
data/lib/seeuletter/client.rb CHANGED
@@ -1,17 +1,19 @@
1
- require "seeuletter/resources/letter"
1
+ # frozen_string_literal: true
2
+
3
+ require 'seeuletter/resources/letter'
2
4
  require 'seeuletter/resources/letter_price'
5
+ require 'seeuletter/resources/postcard'
3
6
  require "seeuletter/resources/user"
4
7
  require "seeuletter/resources/account"
5
8
  require "seeuletter/resources/invoice"
6
9
 
7
10
  module Seeuletter
8
11
  class Client
9
-
10
12
  attr_reader :config
11
13
 
12
14
  def initialize(config = nil)
13
15
  if config.nil? || config[:api_key].nil?
14
- raise ArgumentError.new(":api_key is a required argument to initialize Seeuletter")
16
+ raise ArgumentError, ':api_key is a required argument to initialize Seeuletter'
15
17
  end
16
18
 
17
19
  @config = config
@@ -25,6 +27,10 @@ module Seeuletter
25
27
  Seeuletter::Resources::LetterPrice.new(config)
26
28
  end
27
29
 
30
+ def postcards
31
+ Seeuletter::Resources::Postcard.new(config)
32
+ end
33
+
28
34
  def users
29
35
  Seeuletter::Resources::User.new(config)
30
36
  end
data/lib/seeuletter/resources/postcard.rb ADDED
@@ -0,0 +1,14 @@
1
+ require "seeuletter/resources/resource_base"
2
+
3
+ module Seeuletter
4
+ module Resources
5
+ class Postcard < Seeuletter::Resources::ResourceBase
6
+
7
+ def initialize(config)
8
+ super(config)
9
+ @endpoint = "postcards"
10
+ end
11
+
12
+ end
13
+ end
14
+ end
data/lib/seeuletter/resources/resource_base.rb CHANGED
@@ -93,7 +93,7 @@ module Seeuletter
93
93
  end
94
94
 
95
95
  def base_url
96
- "https://#{config[:api_key]}:@api.seeuletter.com"
96
+ "https://#{config[:api_key]}:@#{config[:host].nil? ? 'api.seeuletter.com' : config[:host]}"
97
97
  end
98
98
 
99
99
  def endpoint_url
data/lib/seeuletter/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Seeuletter
2
- VERSION = "1.4.0"
2
+ VERSION = "1.5.0"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: seeuletter
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 1.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Seeuletter
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-25 00:00:00.000000000 Z
11
+ date: 2024-12-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rest-client
@@ -76,6 +76,7 @@ files:
76
76
  - examples/letter_price.rb
77
77
  - examples/letters.rb
78
78
  - examples/letters_electronic.rb
79
+ - examples/postcards.rb
79
80
  - examples/users.rb
80
81
  - lib/seeuletter.rb
81
82
  - lib/seeuletter/client.rb
@@ -85,6 +86,7 @@ files:
85
86
  - lib/seeuletter/resources/invoice.rb
86
87
  - lib/seeuletter/resources/letter.rb
87
88
  - lib/seeuletter/resources/letter_price.rb
89
+ - lib/seeuletter/resources/postcard.rb
88
90
  - lib/seeuletter/resources/resource_base.rb
89
91
  - lib/seeuletter/resources/user.rb
90
92
  - lib/seeuletter/version.rb