seeuletter 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1408fe288ce4a9b2f41d176873e32c47a2717dcf
-  data.tar.gz: a958dad52b535b938c0d60183969cf99cf6bf148
+SHA256:
+  metadata.gz: 4ae03460189501286ccadd04b8fed5ec5cbaf1fc457b550f0ca559fc655450f0
+  data.tar.gz: e8b36e0d48592e84e60456c9870956a84f85dabd618a8654e6de491925460f97
 SHA512:
-  metadata.gz: 678d19d0e7976d2b154d15f5ff6487d57d8b2da53ec308e91ad8ac9ea904a91e388bb695936d4ce01621f130a0c37937f8ca185616e073427e07457a445b369c
-  data.tar.gz: a5dcf091b2165b1cac85fa2a0742c81e69ffde43bce15862826c4df69ad77a22e3f4ebf7e4437f6dfc5195368bf4af6d18187b0265eb58a6d22b7d54e59c827f
+  metadata.gz: 0ab2e688c5ca19522f28cc73a601d2772290f8be0ae9e1777a1fd833b45a65c0335ef94723324ee78db793a3f2de4e4b2503036a162372d6c28907127d99e535
+  data.tar.gz: 5b9c39c72c7cd3bdf39f30d445ecd6eb2a15fd898f5ca05bd838b0aed6b8f4ee1560f92d07b1170fb10488dccb84fed59a6f1f92e054241c99ad8facd9935eb0

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,82 +1,232 @@
-# 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)
-- [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](#api-documentation) 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 [Settings 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. You'll feel right at home.
-
-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")
-```
-
-#### 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; charset=utf-8"
-```
-
-
-## 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 © 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

@@ -0,0 +1,6 @@
+$:.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)

data/examples/letters.rb

@@ -1,49 +1,49 @@
-$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
-require 'seeuletter'
-
-# initialize Seeuletter object
-seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
-
-html = %{
-<html>
-<head>
-<style>
-  *, *:before, *:after {
-    -webkit-box-sizing: border-box;
-    -moz-box-sizing: border-box;
-    box-sizing: border-box;
-  }
-  .text {
-    margin-left: 50px;
-    padding-top: 450px;
-    font-size: 50px;
-    font-weight: 700;
-  }
-</style>
-</head>
-
-<body>
-  <p class="text">Hello {{name}}!</p>
-</body>
-
-</html>
-}
-
-
-# send the letter
-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,
-  source_file_type: 'html',
-  postage_type: 'prioritaire',
-  variables: { name: 'Erlich'},
-  color: 'color'
-)
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+html = %{
+<html>
+<head>
+<style>
+  *, *:before, *:after {
+    -webkit-box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    box-sizing: border-box;
+  }
+  .text {
+    margin-left: 50px;
+    padding-top: 450px;
+    font-size: 50px;
+    font-weight: 700;
+  }
+</style>
+</head>
+
+<body>
+  <p class="text">Hello {{name}}!</p>
+</body>
+
+</html>
+}
+
+
+# send the letter
+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,
+  source_file_type: 'html',
+  postage_type: 'prioritaire',
+  variables: { name: 'Erlich'},
+  color: 'color'
+)

data/examples/letters_electronic.rb

@@ -0,0 +1,48 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'seeuletter'
+
+# initialize Seeuletter object
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+html = %{
+<html>
+<head>
+<style>
+  *, *:before, *:after {
+    -webkit-box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    box-sizing: border-box;
+  }
+  .text {
+    margin-left: 50px;
+    padding-top: 450px;
+    font-size: 50px;
+    font-weight: 700;
+  }
+</style>
+</head>
+
+<body>
+  <p class="text">Hello {{name}}!</p>
+</body>
+
+</html>
+}
+
+
+# send the letter
+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'
+    }
+)

data/examples/users.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require 'seeuletter'
+
+seeuletter = Seeuletter::Client.new(api_key: '<PUT_YOU_API_KEY_HERE>')
+
+puts seeuletter.users.create_from_api(email: 'email@example.com', name: 'Example')

data/lib/seeuletter/client.rb

@@ -1,21 +1,40 @@
-require "seeuletter/resources/letter"
-
-module Seeuletter
-  class Client
-
-    attr_reader :config
-
-    def initialize(config = nil)
-      if config.nil? || config[:api_key].nil?
-        raise ArgumentError.new(":api_key is a required argument to initialize Seeuletter")
-      end
-
-      @config = config
-    end
-
-    def letters
-      Seeuletter::Resources::Letter.new(config)
-    end
-
-  end
-end
+require "seeuletter/resources/letter"
+require 'seeuletter/resources/letter_price'
+require "seeuletter/resources/user"
+require "seeuletter/resources/account"
+require "seeuletter/resources/invoice"
+
+module Seeuletter
+  class Client
+
+    attr_reader :config
+
+    def initialize(config = nil)
+      if config.nil? || config[:api_key].nil?
+        raise ArgumentError.new(":api_key is a required argument to initialize Seeuletter")
+      end
+
+      @config = config
+    end
+
+    def letters
+      Seeuletter::Resources::Letter.new(config)
+    end
+
+    def letter_price
+      Seeuletter::Resources::LetterPrice.new(config)
+    end
+
+    def users
+      Seeuletter::Resources::User.new(config)
+    end
+
+    def accounts
+      Seeuletter::Resources::Account.new(config)
+    end
+
+    def invoices
+      Seeuletter::Resources::Invoice.new(config)
+    end
+  end
+end

data/lib/seeuletter/errors/invalid_request_error.rb

@@ -1,4 +1,4 @@
-module Seeuletter
-  class InvalidRequestError < SeeuletterError
-  end
-end
+module Seeuletter
+  class InvalidRequestError < SeeuletterError
+  end
+end

data/lib/seeuletter/errors/seeuletter_error.rb

@@ -1,20 +1,20 @@
-module Seeuletter
-
-  class SeeuletterError < StandardError
-    attr_reader :http_status, :http_body, :json_body
-
-    def initialize(message, http_status=nil, http_body=nil, json_body=nil)
-      @http_status = http_status
-      @http_body = http_body
-      @json_body = json_body
-      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
-      super("#{status_string}#{message} \n #{@http_body}")
-    end
-
-    def _response
-      @json_body
-    end
-
-  end
-
-end
+module Seeuletter
+
+  class SeeuletterError < StandardError
+    attr_reader :http_status, :http_body, :json_body
+
+    def initialize(message, http_status=nil, http_body=nil, json_body=nil)
+      @http_status = http_status
+      @http_body = http_body
+      @json_body = json_body
+      status_string = @http_status.nil? ? "" : "(Status #{@http_status}) "
+      super("#{status_string}#{message} \n #{@http_body}")
+    end
+
+    def _response
+      @json_body
+    end
+
+  end
+
+end

data/lib/seeuletter/resources/account.rb

@@ -0,0 +1,30 @@
+require "seeuletter/resources/resource_base"
+
+module Seeuletter
+  module Resources
+    class Account < Seeuletter::Resources::ResourceBase
+
+      def initialize(config)
+        super(config)
+        @endpoint = "accounts"
+      end
+
+      def updateEmail(resource_id, email, headers={})
+          submit :put, resource_url(resource_id), {"email" => email}, headers
+      end
+
+      def list(options={})
+        raise SeeuletterError.new("Invalid REST operation : GET /accounts", "404", nil)
+      end
+
+      def find(resource_id)
+        raise SeeuletterError.new("Invalid REST operation : GET /accounts/:account_id", "404", nil)
+      end
+
+      def destroy(resource_id)
+        raise SeeuletterError.new("Invalid REST operation : DELETE /accounts/:account_id", "404", nil)
+      end
+
+    end
+  end
+end

data/lib/seeuletter/resources/invoice.rb

@@ -0,0 +1,22 @@
+require "seeuletter/resources/resource_base"
+
+module Seeuletter
+  module Resources
+    class Invoice < Seeuletter::Resources::ResourceBase
+
+      def initialize(config)
+        super(config)
+        @endpoint = "invoices"
+      end
+
+      def create(options={}, headers={})
+        raise SeeuletterError.new("Invalid REST operation : POST /invoices", "404", nil)
+      end
+
+      def destroy(resource_id)
+        raise SeeuletterError.new("Invalid REST operation : DELETE /accounts/:invoice_id", "404", nil)
+      end
+
+    end
+  end
+end

data/lib/seeuletter/resources/letter.rb

@@ -1,14 +1,17 @@
-require "seeuletter/resources/resource_base"
-
-module Seeuletter
-  module Resources
-    class Letter < Seeuletter::Resources::ResourceBase
-
-      def initialize(config)
-        super(config)
-        @endpoint = "letters"
-      end
-
-    end
-  end
-end
+require "seeuletter/resources/resource_base"
+
+module Seeuletter
+  module Resources
+    class Letter < Seeuletter::Resources::ResourceBase
+
+        def initialize(config)
+            super(config)
+            @endpoint = "letters"
+        end
+
+        def createElectronic(options={}, headers={})
+            submit :post, resource_url("electronic"), options, headers
+        end
+    end
+  end
+end

data/lib/seeuletter/resources/letter_price.rb

@@ -0,0 +1,14 @@
+require "seeuletter/resources/resource_base"
+
+module Seeuletter
+  module Resources
+    class LetterPrice < Seeuletter::Resources::ResourceBase
+      def initialize(config)
+        super(config)
+        @endpoint = "price/letter"
+      end
+
+      alias get list
+    end
+  end
+end

data/lib/seeuletter/resources/resource_base.rb

@@ -1,109 +1,109 @@
-require "rest-client"
-require "json"
-require "uri"
-
-module Seeuletter
-  module Resources
-    class ResourceBase
-
-      attr_reader :config, :endpoint
-
-      def initialize(config)
-        @config = config
-      end
-
-      def list(options={})
-        submit :get, endpoint_url, options
-      end
-
-      def find(resource_id)
-        submit :get, resource_url(resource_id)
-      end
-
-      def create(options={}, headers={})
-        submit :post, endpoint_url, options, headers
-      end
-
-      def destroy(resource_id)
-        submit :delete, resource_url(resource_id)
-      end
-
-      private
-
-      def submit(method, url, parameters={}, headers={})
-        clientVersion = Seeuletter::VERSION
-
-        begin
-          if method == :get || method == :delete
-            # Hack to URL encode nested objects like metadata.
-            url = "#{url}?#{build_nested_query(parameters)}"
-            response = RestClient.send(method, url, {
-              user_agent: 'Seeuletter/v1 RubyBindings/' + clientVersion,
-              "Seeuletter-Version" => config[:api_version]
-            })
-          else
-            headers = headers.merge({
-              user_agent: 'Seeuletter/v1 RubyBindings/' + clientVersion,
-              "Seeuletter-Version" => config[:api_version]
-            })
-            response = RestClient.send(method, url, parameters, headers)
-          end
-
-          body = JSON.parse(response)
-
-          body.define_singleton_method(:_response) do
-            response
-          end
-
-          return body
-
-        rescue RestClient::ExceptionWithResponse => e
-          handle_api_error(e)
-        end
-      end
-
-      private
-
-      def handle_api_error(error)
-        begin
-          response = JSON.parse(error.http_body.to_s)
-          message = response.fetch("error").fetch("message")
-          raise InvalidRequestError.new(message, error.http_code, error.http_body, error.response)
-        rescue JSON::ParserError, KeyError
-          # :nocov:
-          raise SeeuletterError.new("Invalid response object:", error.http_code, error.http_body)
-          # :nocov:
-        end
-      end
-
-      def build_nested_query(value, prefix = nil)
-        case value
-        when Array
-          value.map { |v|
-            build_nested_query(v, "#{prefix}[]")
-          }.join("&")
-        when Hash
-          value.map { |k, v|
-            build_nested_query(v, prefix ? "#{prefix}[#{URI.encode_www_form_component(k)}]" : URI.encode_www_form_component(k))
-          }.reject(&:empty?).join('&')
-        else
-          raise ArgumentError, "value must be an Array or Hash" if prefix.nil?
-          "#{prefix}=#{URI.encode_www_form_component(value)}"
-        end
-      end
-
-      def base_url
-        "https://#{config[:api_key]}:@api.seeuletter.com"
-      end
-
-      def endpoint_url
-        "#{base_url}/#{endpoint}"
-      end
-
-      def resource_url(resource_id)
-        "#{endpoint_url}/#{resource_id}"
-      end
-
-    end
-  end
-end
+require "rest-client"
+require "json"
+require "uri"
+
+module Seeuletter
+  module Resources
+    class ResourceBase
+
+      attr_reader :config, :endpoint
+
+      def initialize(config)
+        @config = config
+      end
+
+      def list(options={})
+        submit :get, endpoint_url, options
+      end
+
+      def find(resource_id)
+        submit :get, resource_url(resource_id)
+      end
+
+      def create(options={}, headers={})
+        submit :post, endpoint_url, options, headers
+      end
+
+      def destroy(resource_id)
+        submit :delete, resource_url(resource_id)
+      end
+
+      private
+
+      def submit(method, url, parameters={}, headers={})
+        clientVersion = Seeuletter::VERSION
+
+        begin
+          if method == :get || method == :delete
+            # Hack to URL encode nested objects like metadata.
+            url = "#{url}?#{build_nested_query(parameters)}"
+            response = RestClient.send(method, url, {
+              user_agent: 'Seeuletter/v1 RubyBindings/' + clientVersion,
+              "Seeuletter-Version" => config[:api_version]
+            })
+          else
+            headers = headers.merge({
+              user_agent: 'Seeuletter/v1 RubyBindings/' + clientVersion,
+              "Seeuletter-Version" => config[:api_version]
+            })
+            response = RestClient.send(method, url, parameters, headers)
+          end
+
+          body = JSON.parse(response)
+
+          body.define_singleton_method(:_response) do
+            response
+          end
+
+          return body
+
+        rescue RestClient::ExceptionWithResponse => e
+          handle_api_error(e)
+        end
+      end
+
+      private
+
+      def handle_api_error(error)
+        begin
+          response = JSON.parse(error.http_body.to_s)
+          message = response.fetch("error").fetch("message")
+          raise InvalidRequestError.new(message, error.http_code, error.http_body, error.response)
+        rescue JSON::ParserError, KeyError
+          # :nocov:
+          raise SeeuletterError.new("Invalid response object:", error.http_code, error.http_body)
+          # :nocov:
+        end
+      end
+
+      def build_nested_query(value, prefix = nil)
+        case value
+        when Array
+          value.map { |v|
+            build_nested_query(v, "#{prefix}[]")
+          }.join("&")
+        when Hash
+          value.map { |k, v|
+            build_nested_query(v, prefix ? "#{prefix}[#{URI.encode_www_form_component(k)}]" : URI.encode_www_form_component(k))
+          }.reject(&:empty?).join('&')
+        else
+          raise ArgumentError, "value must be an Array or Hash" if prefix.nil?
+          "#{prefix}=#{URI.encode_www_form_component(value)}"
+        end
+      end
+
+      def base_url
+        "https://#{config[:api_key]}:@api.seeuletter.com"
+      end
+
+      def endpoint_url
+        "#{base_url}/#{endpoint}"
+      end
+
+      def resource_url(resource_id)
+        "#{endpoint_url}/#{resource_id}"
+      end
+
+    end
+  end
+end

data/lib/seeuletter/resources/user.rb

@@ -0,0 +1,16 @@
+require "seeuletter/resources/resource_base"
+
+module Seeuletter
+  module Resources
+    class User < Seeuletter::Resources::ResourceBase
+      def initialize(config)
+        super(config)
+        @endpoint = "users"
+      end
+
+      def create_from_api(options={}, headers={})
+        submit :post, "#{endpoint_url}/create_from_api", options, headers
+      end
+    end
+  end
+end

data/lib/seeuletter/version.rb

@@ -1,3 +1,3 @@
-module Seeuletter
-  VERSION = "1.0.0"
-end
+module Seeuletter
+  VERSION = "1.4.0"
+end

data/lib/seeuletter.rb

@@ -1,7 +1,7 @@
-require "seeuletter/client"
-require "seeuletter/version"
-require "seeuletter/errors/seeuletter_error"
-require "seeuletter/errors/invalid_request_error"
-
-module Seeuletter
-end
+require "seeuletter/client"
+require "seeuletter/version"
+require "seeuletter/errors/seeuletter_error"
+require "seeuletter/errors/invalid_request_error"
+
+module Seeuletter
+end

data/seeuletter.gemspec

@@ -1,24 +1,24 @@
-# coding: utf-8
-$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
-
-require "seeuletter/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "seeuletter"
-  spec.version       = Seeuletter::VERSION
-  spec.authors       = ["Seeuletter"]
-  spec.email         = ["hello@seeuletter.com"]
-  spec.description   = %q{Seeuletter API Ruby wrapper}
-  spec.summary       = %q{Ruby wrapper for Seeuletter.com API - ActiveRecord-style syntax}
-  spec.homepage      = "https://github.com/seeuletter/seeuletter-ruby"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "rest-client", ">= 1.8", "< 3.0"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 10.4.2"
-end
+# coding: utf-8
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require "seeuletter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "seeuletter"
+  spec.version       = Seeuletter::VERSION
+  spec.authors       = ["Seeuletter"]
+  spec.email         = ["hello@seeuletter.com"]
+  spec.description   = %q{Seeuletter API Ruby wrapper}
+  spec.summary       = %q{Ruby wrapper for Seeuletter.com API - ActiveRecord-style syntax}
+  spec.homepage      = "https://github.com/seeuletter/seeuletter-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rest-client", ">= 1.8", "< 3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.4.2"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seeuletter
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Seeuletter
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-26 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -71,20 +71,29 @@ files:
 - README.md
 - Rakefile
 - examples/README.md
+- examples/accounts.rb
+- examples/invoices.rb
+- examples/letter_price.rb
 - examples/letters.rb
+- examples/letters_electronic.rb
+- examples/users.rb
 - lib/seeuletter.rb
 - lib/seeuletter/client.rb
 - lib/seeuletter/errors/invalid_request_error.rb
 - lib/seeuletter/errors/seeuletter_error.rb
+- lib/seeuletter/resources/account.rb
+- lib/seeuletter/resources/invoice.rb
 - lib/seeuletter/resources/letter.rb
+- lib/seeuletter/resources/letter_price.rb
 - lib/seeuletter/resources/resource_base.rb
+- lib/seeuletter/resources/user.rb
 - lib/seeuletter/version.rb
 - seeuletter.gemspec
 homepage: https://github.com/seeuletter/seeuletter-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -99,9 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby wrapper for Seeuletter.com API - ActiveRecord-style syntax
 test_files: []