seeuletter 1.1.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c95ab7d39cc66975f788f128075a0678c5af426a
-  data.tar.gz: 3c6582b0e1abd7f6e2366c78f1033f9c3707f055
+SHA256:
+  metadata.gz: 5bc0dfd516e4b918a21c7c592788df8e12b98ccecc428fa59a0fac7c5ec4f771
+  data.tar.gz: '0957b2824afb423e6a1e91a76644e84e58e0f4b1e10c1920afa453d414d9b2b7'
 SHA512:
-  metadata.gz: 52f655b93b2b77029b9a461408388af761651f2a7af372fe2eaa13d23585b117479d3f6c6b276a8c1b6a03803edb7e1bd920f990884db061a00c17abd9142808
-  data.tar.gz: '02864672a80c3e8c18e069766fdebe1214b97259f08a1532c106d7a06841043f586e5a0e8974d09ca8f24bece59c22418f8b7250bd05157fa7c78763c9f883b1'
+  metadata.gz: 33de5980a1dfa835a8c5547352b3a5f87c2562d504a66b2e128be536d347bb1b9847ca09890f09ad001bf1b8fc2f40cd197d6c0f78dcdb77568d0fb1c5740e4d
+  data.tar.gz: b5e47137fc690881260c1357566e7187a73d05b993e9621a1ff1a4cc15015808c7ee4fe143541a5d65779026126f5d6e55a46ebce7aa427c8f149c77c4c4280c

data/.gitignore

@@ -1,14 +1,14 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-.DS_Store
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-lib/bundler/man
-pkg
-rdoc
-tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.DS_Store
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+tmp

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in seeuletter.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seeuletter.gemspec
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2017 Seeuletter.com
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright (c) 2017 Seeuletter.com
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,142 +1,232 @@
-# seeuletter-ruby
-
-
-[![Gem Version](https://badge.fury.io/rb/seeuletter.svg)](https://badge.fury.io/rb/seeuletter)
-
-
-Ruby wrapper for the [Seeuletter.com](https://www.seeuletter.com) API. See the full Seeuletter.com [API Documentation](https://docs.seeuletter.com/?ruby#).  For best results, be sure that you're using the latest version of the Seeuletter API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Seeuletter.com API.
-
-Supports Ruby 2.0.0 and greater.
-
-## Table of Contents
-
-- [Getting Started](#getting-started)
-  - [Registration](#registration)
-  - [Installation](#installation)
-  - [Usage](#usage)
-- [Examples](#examples)
-
-## Getting Started
-
-Here's a general overview of the Seeuletter services available, click through to read more.
-
-Please read through the official [API Documentation](https://docs.seeuletter.com/?ruby#) to get a complete sense of what to expect from each endpoint.
-
-### Registration
-
-First, you will need to first create an account at [Seeuletter.com](https://www.seeuletter.com/signup) and obtain your Test and Live API Keys.
-
-Once you have created an account, you can access your API Keys from the [API Keys Panel](https://www.seeuletter.com/app/dashboard/keys).
-
-### Installation
-
-Add this line to your application's `Gemfile`:
-
-    gem 'seeuletter'
-
-And then execute:
-
-    $ bundle
-
-Or manually install it yourself:
-
-    $ gem install seeuletter
-
-### Usage
-
-The library uses an ActiveRecord-style interface.
-
-For optional parameters and other details, refer to the docs [here](https://docs.seeuletter.com/?ruby#).
-
-#### Initialization and Configuration
-
-```ruby
-# To initialize a Seeuletter object
-seeuletter = Seeuletter::Client.new(api_key: "your-api-key")
-```
-
-#### Create a new letter
-
-```ruby
-# send the letter
-require 'seeuletter'
-
-# initialize Seeuletter object
-seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
-
-puts seeuletter.letters.create(
-  description: "Test letter from the Ruby Wrapper",
-  to: {
-    name: 'Erlich',
-    address_line1: '30 rue de rivoli',
-    address_line2: '',
-    address_city: 'Paris',
-    address_country: 'France',
-    address_postalcode: '75004'
-  },
-  source_file: '<html>Hello {{name}}</html>',
-  source_file_type: 'html',
-  postage_type: 'prioritaire',
-  variables: { name: 'Erlich'},
-  color: 'color'
-)
-```
-
-#### List all letters
-
-```ruby
-require 'seeuletter'
-
-seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
-
-puts seeuletter.letters.list()
-```
-
-#### Get a specific letter
-
-```ruby
-require 'seeuletter'
-
-seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
-
-puts seeuletter.letters.find('LETTER_ID')
-```
-#### Get the price of a letter
-
-```ruby
-require 'seeuletter'
-
-seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
-
-puts seeuletter.letter_price.get(color: 'bw', postage_type: 'prioritaire', postage_speed: 'D1', page_count: 1)
-```
-
-#### Caution: Pass zero-prefixed postal codes as strings
-
-When using postal codes with zero-prefixes, always quote them. For example when specifying `02125`, pass it as a string `"02125"`, instead of an integer.
-
-The Ruby interpreter assumes it's not of base-10 and tries to convert it to base-10 number. So that might result in an entirely different postal code than intended.
-
-#### Accessing Response Headers
-
-You can access response headers via a hidden `headers` method on the response hash.
-
-```ruby
-addresses = seeuletter.addresses.list
-
-addresses._response.headers[:content_type]
-# => "application/json"
-```
-
-
-## Examples
-
-We've provided various examples for you to try out [here](https://github.com/seeuletter/seeuletter-ruby/tree/master/examples).
-
-There are simple scripts to demonstrate how to create all letters with the Seeuletter API Ruby wrapper.
-
-=======================
-
-Copyright &copy; 2017 Seeuletter.com
-
-Released under the MIT License, which can be found in the repository in `LICENSE.txt`.
+# seeuletter-ruby
+
+
+[![Gem Version](https://badge.fury.io/rb/seeuletter.svg)](https://badge.fury.io/rb/seeuletter)
+[![Dependency Status](https://gemnasium.com/badges/github.com/seeuletter/seeuletter-ruby.svg)](https://gemnasium.com/github.com/seeuletter/seeuletter-ruby)
+
+
+Ruby wrapper for the [Seeuletter.com](https://www.seeuletter.com) API. See the full Seeuletter.com [API Documentation](https://docs.seeuletter.com/?ruby#).  For best results, be sure that you're using the latest version of the Seeuletter API and the latest version of the ruby wrapper. This gem gives you an ActiveRecord-style syntax to use the Seeuletter.com API.
+
+Supports Ruby 2.0.0 and greater.
+
+## Table of Contents
+
+- [Getting Started](#getting-started)
+  - [Registration](#registration)
+  - [Installation](#installation)
+  - [Usage](#usage)
+  - [Letters](#letters)
+  - [Accounts](#accounts)
+  - [Invoices](#invoices)
+- [Examples](#examples)
+
+## Getting Started
+
+Here's a general overview of the Seeuletter services available, click through to read more.
+
+Please read through the official [API Documentation](https://docs.seeuletter.com/?ruby#) to get a complete sense of what to expect from each endpoint.
+
+### Registration
+
+First, you will need to first create an account at [Seeuletter.com](https://www.seeuletter.com/signup) and obtain your Test and Live API Keys.
+
+Once you have created an account, you can access your API Keys from the [API Keys Panel](https://www.seeuletter.com/app/dashboard/keys).
+
+### Installation
+
+Add this line to your application's `Gemfile`:
+
+    gem 'seeuletter'
+
+And then execute:
+
+    $ bundle
+
+Or manually install it yourself:
+
+    $ gem install seeuletter
+
+### Usage
+
+The library uses an ActiveRecord-style interface.
+
+For optional parameters and other details, refer to the docs [here](https://docs.seeuletter.com/?ruby#).
+
+#### Initialization and Configuration
+
+```ruby
+# To initialize a Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: "your-api-key")
+```
+
+### Letters
+
+#### Create a new letter
+
+```ruby
+# send the letter
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+puts seeuletter.letters.create(
+  description: "Test letter from the Ruby Wrapper",
+  to: {
+    name: 'Erlich',
+    address_line1: '30 rue de rivoli',
+    address_line2: '',
+    address_city: 'Paris',
+    address_country: 'France',
+    address_postalcode: '75004'
+  },
+  source_file: '<html>Hello {{name}}</html>',
+  source_file_type: 'html',
+  postage_type: 'prioritaire',
+  variables: { name: 'Erlich'},
+  color: 'color'
+)
+```
+
+#### Create a new electronic letter
+
+```ruby
+# send the letter
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+puts seeuletter.letters.createElectronic(
+    description: "Test electronic letter from the Ruby Wrapper",
+    to: {
+        email: 'erlich.dumas@example.com',
+        first_name: 'Erlich',
+        last_name: 'Dumas',
+        status: 'individual'
+    },
+    source_file: '<html>Hello {{name}}</html>',
+    source_file_type: 'html',
+    postage_type: 'lre',
+    variables: {
+    	name: 'Erlich'
+    }
+)
+```
+
+#### List all letters
+
+```ruby
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.letters.list()
+```
+
+#### Get a specific letter
+
+```ruby
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.letters.find('LETTER_ID')
+```
+#### Get the price of a letter
+
+```ruby
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.letter_price.get(color: 'bw', postage_type: 'prioritaire', postage_speed: 'D1', page_count: 1)
+```
+
+### Accounts
+
+#### Create a new account for the company
+
+```ruby
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.accounts.create(
+  email: "msb.partner@example.com",
+  name: "Erlich Bachman",
+  phone: "+33104050607",
+  company_name: "MSB Partner from Ruby Wrapper",
+  address_line1: '30 rue de rivoli',
+  address_line2: '',
+  address_city: 'Paris',
+  address_country: 'France',
+  address_postalcode: '75004'
+)
+```
+
+### Update the account company email
+
+```ruby
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+seeuletter.accounts.updateEmail('ACCOUNT_COMPANY_ID', "msb.partner.new@example.com")
+```
+
+
+
+### Invoices
+
+#### List all invoices for a company
+
+```ruby
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.invoices.list()
+```
+
+#### Get a specific invoice
+
+```ruby
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: 'test_12345678901234567890')
+
+puts seeuletter.invoices.find('INVOICE_ID')
+```
+
+#### Caution: Pass zero-prefixed postal codes as strings
+
+When using postal codes with zero-prefixes, always quote them. For example when specifying `02125`, pass it as a string `"02125"`, instead of an integer.
+
+The Ruby interpreter assumes it's not of base-10 and tries to convert it to base-10 number. So that might result in an entirely different postal code than intended.
+
+#### Accessing Response Headers
+
+You can access response headers via a hidden `headers` method on the response hash.
+
+```ruby
+addresses = seeuletter.addresses.list
+
+addresses._response.headers[:content_type]
+# => "application/json"
+```
+
+
+## Examples
+
+We've provided various examples for you to try out [here](https://github.com/seeuletter/seeuletter-ruby/tree/master/examples).
+
+There are simple scripts to demonstrate how to create all letters with the Seeuletter API Ruby wrapper.
+
+=======================
+
+Copyright &copy; 2017 Seeuletter.com
+
+Released under the MIT License, which can be found in the repository in `LICENSE.txt`.

data/Rakefile

@@ -1,7 +1,7 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.verbose = true
-end
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.verbose = true
+end

data/examples/README.md

@@ -1,17 +1,31 @@
-# Ruby Examples
-
-Here you can find some examples to help you get started with the Ruby wrapper. 
-
-## Getting started
-Before running these examples make sure you are in the `examples/` directory.
-```
-cd examples/
-```
-
-## Examples
-
-
-### Create a letter
-```
-ruby letters.rb
-```
+# Ruby Examples
+
+Here you can find some examples to help you get started with the Ruby wrapper. 
+
+## Getting started
+Before running these examples make sure you are in the `examples/` directory.
+```
+cd examples/
+```
+
+## Examples
+
+### Create a letter
+```
+ruby letters.rb
+```
+
+### Create an electronic letter
+```
+ruby letters_electronic.rb
+```
+
+### Create and update account
+```
+ruby accounts.rb
+```
+
+### Get invoices
+```
+ruby invoices.rb
+```

data/examples/accounts.rb

@@ -0,0 +1,27 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+begin
+    # create a new company account
+    create_response = seeuletter.accounts.create(
+      email: "msb.partner@example.com",
+      name: "Erlich Bachman",
+      phone: "+33104050607",
+      company_name: "MSB Partner from Ruby Wrapper",
+      address_line1: '30 rue de rivoli',
+      address_line2: '',
+      address_city: 'Paris',
+      address_country: 'France',
+      address_postalcode: '75004'
+    )
+    puts "The Seeuletter API Account responded : #{create_response}"
+
+    # update email of a company account
+    seeuletter.accounts.updateEmail(create_response['company']['_id'], "msb.partner.new@example.com")
+
+rescue Seeuletter::SeeuletterError => ex
+    puts "Error from API : #{ex}"
+end

data/examples/invoices.rb

@@ -0,0 +1,21 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+begin
+    # get list of invoices
+    list_response = seeuletter.invoices.list(
+        status: "paid",
+        date_start: "2020-01-01"
+    )
+    puts "The Seeuletter API Invoices responded : #{list_response}"
+
+    # get single invoice by API
+    find_response = seeuletter.invoices.find(list_response['invoices'][0]['_id'])
+    puts "The Seeuletter API Invoice responded : #{find_response}"
+
+rescue Seeuletter::SeeuletterError => ex
+    puts "Error from API : #{ex}"
+end

data/examples/letter_price.rb

@@ -1,6 +1,6 @@
-$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
-require 'seeuletter'
-
-seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
-
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
 puts seeuletter.letter_price.get(color: 'bw', postage_type: 'prioritaire', postage_speed: 'D1', page_count: 1)