smtp_lw 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3efabcaa3ceaa595c095edfe080b06260fe42129
-  data.tar.gz: 4dc97e0015d1f91671d369d0f27bba99db9b1395
+  metadata.gz: ebe8f2235d7522ac67b6d0eaf36439d2bdbb122e
+  data.tar.gz: 55dc00ab47d2d8d00b7bd7da9a3cdcf39628e479
 SHA512:
-  metadata.gz: 038a41f470b8179c3f6e30f5de8739b262b069cf8d39b12ea497015ce0b901d2c57be68e5f7473e8202bab2e3b39a47701f021b9e7d77f62aea5c5332f39e8a5
-  data.tar.gz: 9b28fbab501fdc7032088f603e7b236c68b85cce6004516d51690ab5621d505ccfc46e76d3c946a6a47d8fc714445fedd039173098e1971793c15f874e72e5f3
+  metadata.gz: 415759598fd81071c907cc1b2933254d59cee35c729fb8efe80aa0904b9f56c10afab3e87bfd4331bb7934941eec0edd40bc046b1233bf1a1f23b33c29524db8
+  data.tar.gz: 1e82ad623bae16332f5ecd619ba28715b676b6fb91cbd1d235940a7f4662261dbc38a45eeb096753f5bd1e53adf6f93f4fb4ba688547307d0b2788351ad02862

data/.gitignore

@@ -13,4 +13,3 @@
 *.a
 mkmf.log
 .env
-test/fixtures/*.yml

data/.rubocop.yml

@@ -0,0 +1,241 @@
+AllCops:
+  Exclude:
+    - '**/vendor/**'
+    - '**/db/**/*'
+    - '**/script/**'
+
+  DisplayCopNames: true
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: indent
+  IndentationWidth: ~
+
+Style/Alias:
+  EnforcedStyle: prefer_alias
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+  EnforcedLastArgumentHashStyle: always_inspect
+
+Style/AlignParameters:
+  EnforcedStyle: with_first_parameter
+
+Style/BarePercentLiterals:
+  EnforcedStyle: bare_percent
+  SupportedStyles:
+    - percent_q
+    - bare_percent
+
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: no_braces
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested
+
+Style/Documentation:
+  Enabled: false
+
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/EmptyElse:
+  EnforcedStyle: both
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: false
+
+Style/EmptyLinesAroundBlockBody:
+  EnforcedStyle: no_empty_lines
+
+Style/EmptyLinesAroundClassBody:
+  EnforcedStyle: no_empty_lines
+
+Style/EmptyLinesAroundModuleBody:
+  EnforcedStyle: no_empty_lines
+
+Style/FirstParameterIndentation:
+  EnforcedStyle: special_for_inner_method_call_in_parentheses
+  IndentationWidth: ~
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: when_needed
+
+Style/GlobalVars:
+  AllowedVariables: []
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+  UseHashRocketsWithSymbolValues: false
+
+Style/IfUnlessModifier:
+  MaxLineLength: 80
+
+Style/IndentationConsistency:
+  EnforcedStyle: normal
+
+Style/IndentationWidth:
+  Width: 2
+
+Style/IndentArray:
+  EnforcedStyle: special_inside_parentheses
+
+Style/IndentHash:
+  EnforcedStyle: special_inside_parentheses
+
+Style/NonNilCheck:
+  IncludeSemanticChanges: false
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+
+Style/MethodName:
+  EnforcedStyle: snake_case
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: aligned
+
+Style/NumericLiterals:
+  MinDigits: 5
+
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: true
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': ()
+    '%W': ()
+    '%x': ()
+
+Style/PercentQLiterals:
+  EnforcedStyle: lower_case_q
+
+Style/PredicateName:
+  NamePrefix:
+    - is_
+    - has_
+    - have_
+  NamePrefixBlacklist:
+    - is_
+    - has_
+    - have_
+  NameWhitelist:
+    - is_a?
+
+Style/SignalException:
+  EnforcedStyle: only_fail
+
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: true
+
+Style/SpaceBeforeFirstArg:
+  AllowForAlignment: true
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  ConsistentQuotesInMultiline: false
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: single_quotes
+
+Style/SpaceAroundBlockParameters:
+  EnforcedStyleInsidePipes: no_space
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+
+Style/SpaceAroundOperators:
+  AllowForAlignment: true
+
+Style/SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+
+Style/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+  SpaceBeforeBlockParameters: true
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+
+Style/SymbolArray:
+  EnforcedStyle: percent
+
+Style/TrailingBlankLines:
+  EnforcedStyle: final_newline
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/VariableName:
+  EnforcedStyle: snake_case
+
+##################### Metrics ##################################
+
+Metrics/BlockNesting:
+  Max: 3
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 100
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+
+Metrics/LineLength:
+  Max: 100
+  AllowHeredoc: true
+  AllowURI: true
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 10
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+##################### Lint ##################################
+
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: true
+
+Lint/EndAlignment:
+  AlignWith: keyword
+  AutoCorrect: false
+
+Lint/DefEndAlignment:
+  AlignWith: start_of_line
+  AutoCorrect: false
+
+Lint/UnusedBlockArgument:
+  IgnoreEmptyBlocks: true
+
+Lint/UnusedMethodArgument:
+  AllowUnusedKeywordArguments: false
+  IgnoreEmptyMethods: true
+
+##################### Performance ############################
+
+Performance/RedundantMerge:
+  MaxKeyValuePairs: 2

data/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Contributing to SmtpLw
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by refactoring code
+* by closing [issues][]
+* by reviewing patches
+
+[issues]: https://github.com/locaweb/smtp_lw/issues
+
+## Submitting an Issue
+We use the [GitHub issue tracker][issues] to track bugs and features. Before
+submitting a bug report or feature request, check to make sure it hasn't
+already been submitted. When submitting a bug report, please include a [Gist][]
+that includes a stack trace and any details that may be necessary to reproduce
+the bug, including your gem version, Ruby version, and operating system.
+Ideally, a bug report should include a pull request with failing specs.
+
+[gist]: https://gist.github.com/
+
+## Submitting a Pull Request
+1. [Fork][fork] the [official repository][repo].
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Add, commit, and push your changes.
+5. [Submit a pull request.][pr]
+
+## Notes
+* Please add tests and run Rubocop to check for offenses if you changed code. Contributions without tests or with Rubocop offenses won't be accepted.
+* Please don't update the Gem version.
+
+[repo]: https://github.com/locaweb/smtp_lw/tree/master
+[fork]: https://help.github.com/articles/fork-a-repo/
+[branch]: https://help.github.com/articles/creating-and-deleting-branches-within-your-repository/
+[pr]: https://help.github.com/articles/using-pull-requests/
+
+Inspired by https://github.com/thoughtbot/factory_girl/blob/master/CONTRIBUTING.md

data/{LICENSE.txt → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Rachad Honein
+Copyright (c) 2015-2016 Locaweb
 
 MIT License
 

data/README.md

@@ -4,19 +4,15 @@ This is the ruby client for SMTP Locaweb product.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```shell
+gem install smtp_lw
+```
+or add this line to Gemfile:
 
 ```ruby
 gem 'smtp_lw'
 ```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install smtp_lw
+and run `bundle install` from your shell.
 
 ## Usage
 
@@ -24,7 +20,6 @@ Or install it yourself as:
 ```ruby
 client = SmtpLw::Client.new(api_token: 'your api token from the panel')
 ```
-
 or
 
 ```ruby
@@ -33,40 +28,44 @@ SmtpLw.configure do |c|
   c.per_page = 50
 end
 
-# instanciate the client
+# instantiate the client
 client = SmtpLw::Client.new
 ```
 
-Alternatively you can authenticate setting an ENV: 
+You can also authenticate setting an environment variable
 
-```
+```shell
 SMTP_LW_API_TOKEN='your api token'
 ```
-and then:
+and then use the client
 ```ruby
 client = SmtpLw::Client.new
 ```
 
-### Get the list of messages
+### Retrieving messages for a given period
 
 ```ruby
 client.list_messages('all', '2015-07-01', '2015-07-30')
 ```
-You can pass options as specified in the API documentation:
+
+You can pass options as specified in the [API documentation](http://developer.locaweb.com.br/documentacoes/smtp/):
 ```ruby
-client.list_messages('all', '2015-07-01', '2015-07-30' {page: 1, per: 50})
+client.list_messages('all', '2015-07-01', '2015-07-30', {page: 1, per: 50})
 ```
 
-### Send a message
+### Sending a message
+
 ```ruby
-client.send_message("meeting tomorrow at 11", "this is the body of my msg", 'me@domain.com',
+client.send_message('meeting tomorrow at 11', 'this is the body of my msg', 'me@domain.com',
 'you@domain.com')
 ```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/smtp_lw/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Please see [CONTRIBUTING.md](https://github.com/locaweb/smtp_lw/blob/master/CONTRIBUTING.md).
+
+## License 
+
+smtp_lw is Copyright © 2015-2016 Locaweb. It is free
+software, and may be redistributed under the terms specified in the
+[LICENSE](/LICENSE) file.

data/Rakefile

@@ -1,5 +1,4 @@
-require "bundler/gem_tasks"
-
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
@@ -8,5 +7,4 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => :test
-
+task default: :test

data/lib/smtp_lw.rb

@@ -1,13 +1,12 @@
 module SmtpLw
-  require "smtp_lw/version"
-  require "smtp_lw/default"
-  require "smtp_lw/configurable"
-  require "smtp_lw/client"
+  require 'smtp_lw/version'
+  require 'smtp_lw/default'
+  require 'smtp_lw/configurable'
+  require 'smtp_lw/client'
   require 'dotenv'
 
   class << self
     Dotenv.load
     include SmtpLw::Configurable
   end
-
 end

data/lib/smtp_lw/client.rb

@@ -7,9 +7,11 @@ module SmtpLw
     attr_accessor :api_token, :api_endpoint, :per_page, :timeout
     include SmtpLw::Client::Messages
 
-    def initialize(options={})
+    def initialize(options = {})
       SmtpLw::Configurable.keys.each do |key|
-        instance_variable_set(:"@#{key}", options[key] || SmtpLw.instance_variable_get(:"@#{key}"))
+        instance_variable_set(
+          :"@#{key}", options[key] || SmtpLw.instance_variable_get(:"@#{key}")
+        )
       end
     end
 
@@ -18,9 +20,8 @@ module SmtpLw
     # @param uri [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Query and header params for request
     # @return [Faraday::Response]
-    def get(uri, options={})
-      options = paginate(options)
-      response = connection.get uri, options
+    def get(uri, options = {})
+      connection.get(uri, options)
     end
 
     # Make a HTTP POST request
@@ -28,8 +29,8 @@ module SmtpLw
     # @param uri [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Body and header params for request
     # @return [Faraday::Response]
-    def post(uri, options={})
-      response = connection.post uri, options
+    def post(uri, options = {})
+      connection.post(uri, options)
     end
 
     # Make a HTTP PUT request
@@ -37,44 +38,29 @@ module SmtpLw
     # @param uri [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Body and header params for request
     # @return [Faraday::Response]
-    def put(uri, options={})
-      response = connection.put uri, options
+    def put(uri, options = {})
+      connection.put(uri, options)
     end
 
     def next_page(raw)
-      next_uri = raw["links"]["next"]
+      next_uri = raw['links']['next']
       return nil unless next_uri
-      response = connection.get next_uri
-      return response.body
+      response = connection.get(next_uri)
+      response.body
     end
 
     private
 
-    def paginate(options)
-      page = options[:page] || 1
-      per = options[:per] || (@per_page || SmtpLw.per_page)
-      options.merge(page: page, per: per)
-    end
-
     def connection
-      conn = Faraday.new(url: (@api_endpoint || SmtpLw.api_endpoint), ssl: {verify: false}) do |c|
+      conn = Faraday.new(url: (@api_endpoint || SmtpLw.api_endpoint), ssl: { verify: false }) do |c|
         c.request :json
         c.response :json
         c.adapter Faraday.default_adapter
-
       end
+
       conn.headers['User-Agent'] = "SMTP LW Ruby API Client v#{VERSION}"
       conn.headers['x-auth-token'] = @api_token || SmtpLw.api_token
       conn
     end
-
-    def per_page
-      @per_page || SmtpLw.per_page
-    end
-
-    def api_endpoint
-      @api_endpoint || SmtpLw.api_endpoint
-    end
-
   end
 end

data/lib/smtp_lw/client/messages.rb

@@ -1,16 +1,35 @@
 module SmtpLw
   class Client
     module Messages
+      def list_messages(status, start_date, end_date, options = {})
+        options = paginate(options)
+        res = get(
+          'messages/',
+          options.merge(status: status, start_date: start_date, end_date: end_date)
+        )
+        res.body
+      end
 
-      def list_messages(status, start_date, end_date, options={})
-        res = get "messages/", options.merge({status: status, start_date: start_date, end_date: end_date})
+      def get_message(id)
+        res = get("messages/#{id}")
         res.body
       end
 
-      def send_message(subject, body, from, to, options={})
-        res = post "messages", options.merge({subject: subject, body: body, from: from, to: to})
+      def send_message(subject, body, from, to, options = {})
+        res = post(
+          'messages',
+          options.merge(subject: subject, body: body, from: from, to: to)
+        )
         res.body
       end
+
+      private
+
+      def paginate(options)
+        page = options[:page] || 1
+        per = options[:per] || (@per_page || SmtpLw.per_page)
+        options.merge(page: page, per: per)
+      end
     end
   end
 end

data/lib/smtp_lw/configurable.rb

@@ -43,7 +43,5 @@ module SmtpLw
       end
       self
     end
-
   end
 end
-

data/lib/smtp_lw/default.rb

@@ -1,7 +1,7 @@
 module SmtpLw
   module Default
-    API_BASE = "https://api.smtplw.com.br".freeze
-    API_VERSION = "/v1/".freeze
+    API_BASE = 'https://api.smtplw.com.br'.freeze
+    API_VERSION = '/v1/'.freeze
 
     class << self
       def api_endpoint
@@ -21,7 +21,7 @@ module SmtpLw
       end
 
       def options
-        Hash[SmtpLw::Configurable.keys.map{|key| [key, send(key)]}]
+        Hash[SmtpLw::Configurable.keys.map { |key| [key, send(key)] }]
       end
 
       # used for pagination when available on get

data/lib/smtp_lw/version.rb

@@ -1,3 +1,3 @@
 module SmtpLw
-  VERSION = "0.0.4"
+  VERSION = '0.0.5'.freeze
 end

data/smtp_lw.gemspec

@@ -4,28 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'smtp_lw/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "smtp_lw"
+  spec.name          = 'smtp_lw'
   spec.version       = SmtpLw::VERSION
-  spec.authors       = ["Locaweb"]
-  spec.email         = ["desenvolvedores@locaweb.com.br"]
-  spec.summary       = %q{This is the ruby client for SMTP Locaweb product.}
-  spec.description   = %q{This is the ruby client for SMTP Locaweb product.}
-  spec.homepage      = "https://github.com/locaweb/smtp_lw"
-  spec.license       = "MIT"
+  spec.authors       = ['Locaweb']
+  spec.email         = ['desenvolvedores@locaweb.com.br']
+  spec.summary       = %(This is the ruby client for SMTP Locaweb product.)
+  spec.description   = %(This is the ruby client for SMTP Locaweb product.)
+  spec.homepage      = 'https://github.com/locaweb/smtp_lw'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday'
   spec.add_dependency 'faraday_middleware'
   spec.add_dependency 'dotenv'
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
-  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'rubocop'
 end

data/test/fixtures/test_0001_find_messages_with_required_filters.yml

@@ -0,0 +1,40 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.smtplw.com.br/v1/messages/?end_date=2015-01-07&page=1&per=10&start_date=2015-01-07&status=all
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - SMTP LW Ruby API Client v0.0.4
+      X-Auth-Token:
+      - "<STMP_LW_API_TOKEN>"
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: Accepted
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+    body:
+      encoding: UTF-8
+      string: '{
+        "data": {
+          "messages": [
+            ["message 1", "message 2"]
+          ]
+        }
+      }'
+      http_version:
+  recorded_at: Tue, 12 Jan 2016 14:47:37 GMT
+recorded_with: VCR 3.0.1

data/test/fixtures/test_0002_will_send_a_message.yml

@@ -0,0 +1,42 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.smtplw.com.br/v1/messages
+    body:
+      encoding: UTF-8
+      string: '{"subject":"hello","body":"this is just a message","from":"bruno.batalha@locaweb.com.br","to":"rachad.honein@gmail.com"}'
+    headers:
+      User-Agent:
+      - SMTP LW Ruby API Client v0.0.4
+      X-Auth-Token:
+      - "<STMP_LW_API_TOKEN>"
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: Accepted
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+    body:
+      encoding: UTF-8
+      string: '{
+        "data": {
+          "attributes": {
+            "status": "Enfileirado"
+          }
+        }
+      }'
+      http_version:
+  recorded_at: Tue, 12 Jan 2016 14:47:37 GMT
+recorded_with: VCR 3.0.1

data/test/fixtures/test_0003_returns_a_message.yml

@@ -0,0 +1,57 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.smtplw.com.br/v1/messages/123
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      User-Agent:
+      - SMTP LW Ruby API Client v0.0.4
+      X-Auth-Token:
+      - "<STMP_LW_API_TOKEN>"
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 201 OK
+    body:
+      encoding: UTF-8
+      string: '{
+                "links": {
+                  "self": "https://api.smtplw.com.br/v1/messages/123"
+                },
+                "data": {
+                  "attributes": {
+                    "from": "info@locaweb.com.br",
+                    "to": "some.email@locaweb.com.br",
+                    "cc": null,
+                    "bcc": null,
+                    "subject": "qualquer titulo",
+                    "body": "qualquer corpo",
+                    "headers": {
+                      "Content-Type": "text/plain",
+                      "x-source": "api",
+                      "x-api-message-id": 123
+                    },
+                    "status": "Enviado",
+                    "response": null
+                  }
+                }
+              }'
+      http_version:
+  recorded_at: Tue, 12 Jan 2016 14:47:37 GMT
+recorded_with: VCR 3.0.1

data/test/lib/smtp_lw/client/messages_test.rb

@@ -1,7 +1,6 @@
 require_relative '../../../test_helper'
 
 describe SmtpLw::Client::Messages do
-
   subject { SmtpLw::Client.new }
 
   before do
@@ -12,14 +11,27 @@ describe SmtpLw::Client::Messages do
     VCR.eject_cassette
   end
 
-  it "find messages with required filters" do
-    raw  = subject.list_messages('all', '2015-01-07', '2015-01-07', per: 10)
-    assert_equal raw["data"]["messages"].count>0, true
+  it 'find messages with required filters' do
+    raw = subject.list_messages('all', '2015-01-07', '2015-01-07', per: 10)
+    assert_equal raw['data']['messages'].count > 0, true
   end
 
-  it "will send a  message" do
-    raw  = subject.send_message('hello', 'this is just a message', 'bruno.batalha@locaweb.com.br', 'rachad.honein@gmail.com')
+  it 'will send a message' do
+    raw = subject.send_message(
+      'hello',
+      'this is just a message',
+      'bruno.batalha@locaweb.com.br',
+      'rachad.honein@gmail.com'
+    )
     assert_equal raw['data']['attributes']['status'], 'Enfileirado'
   end
-end
 
+  it 'returns a message' do
+    raw = subject.get_message('123')
+    assert_equal raw['data']['attributes']['status'], 'Enviado'
+    assert_equal raw['data']['attributes']['from'], 'info@locaweb.com.br'
+    assert_equal raw['data']['attributes']['to'], 'some.email@locaweb.com.br'
+    assert_equal raw['data']['attributes']['headers'].count, 3
+    assert_equal raw['data']['attributes']['headers']['x-api-message-id'], 123
+  end
+end

data/test/lib/smtp_lw/client_test.rb

@@ -1,12 +1,10 @@
 require_relative '../../test_helper'
 
 describe SmtpLw::Client do
-
   subject { SmtpLw::Client }
 
-  it "must return authentication options of client" do
+  it 'must return authentication options of client' do
     client = subject.new(api_token: 'my_api_key')
-    assert_equal client.api_token, "my_api_key"
+    assert_equal client.api_token, 'my_api_key'
   end
-
 end

data/test/lib/smtp_lw/configurable_test.rb

@@ -1,20 +1,18 @@
 require_relative '../../test_helper'
 
 describe SmtpLw do
-
-  it "must give the correct api token" do
+  it 'must give the correct api token' do
     SmtpLw.configure do |c|
       c.api_token = 'secret_token'
     end
     assert_equal SmtpLw.api_token, 'secret_token'
   end
 
-  it "has to reset the default keys if needed" do
+  it 'has to reset the default keys if needed' do
     SmtpLw.configure do |c|
       c.api_token = 'secret_token'
     end
     SmtpLw.reset!
     assert_equal SmtpLw.api_token, ENV['SMTP_LW_API_TOKEN']
   end
-
 end

data/test/lib/smtp_lw/default_test.rb

@@ -1,9 +1,7 @@
 require_relative '../../test_helper'
 
 describe SmtpLw do
-
-  it "must give the correct api endpoint" do
-    assert_equal SmtpLw::Default.api_endpoint, "https://api.smtplw.com.br/v1/"
+  it 'must give the correct api endpoint' do
+    assert_equal SmtpLw::Default.api_endpoint, 'https://api.smtplw.com.br/v1/'
   end
-
 end

data/test/lib/smtp_lw/version_test.rb

@@ -1,9 +1,7 @@
 require_relative '../../test_helper'
 
 describe SmtpLw do
-
-  it "must be defined" do
+  it 'must be defined' do
     SmtpLw::VERSION.wont_be_nil
   end
-
 end

data/test/test_helper.rb

@@ -6,27 +6,28 @@ require 'vcr'
 require 'dotenv'
 require File.expand_path('../../lib/smtp_lw.rb', __FILE__)
 
-
 Dotenv.load
 
 VCR.configure do |c|
-  c.cassette_library_dir = "test/fixtures"
+  ENV['SMTP_LW_API_TOKEN'] = 'my-api-test-token'
+
+  c.cassette_library_dir = 'test/fixtures'
   c.hook_into :webmock
-  c.filter_sensitive_data("<STMP_LW_API_TOKEN>") do
+  c.filter_sensitive_data('<STMP_LW_API_TOKEN>') do
     test_api_token
   end
 end
 
 def test_api_token
-  ENV.fetch 'SMTP_LW_API_TOKEN', 'my-api-test-token'
+  ENV.fetch('SMTP_LW_API_TOKEN', 'my-api-test-token')
 end
 
 module Minitest
   module Reporters
     class CustomReporter < DefaultReporter
-      GRAY = '0;36'
-      GREEN = '1;32'
-      RED = '1;31'
+      GRAY = '0;36'.freeze
+      GREEN = '1;32'.freeze
+      RED = '1;31'.freeze
 
       def initialize(options = {})
         super
@@ -42,7 +43,7 @@ module Minitest
       end
 
       def color_up(string, color)
-        color? ? "\e\[#{ color }m#{ string }#{ ANSI::Code::ENDCODE }" : string
+        color? ? "\e\[#{color}m#{string}#{ANSI::Code::ENDCODE}" : string
       end
 
       def red(string)
@@ -61,4 +62,6 @@ module Minitest
 end
 
 reporter_options = { color: true, slow_count: 5 }
-Minitest::Reporters.use! [Minitest::Reporters::CustomReporter.new(reporter_options)]
+Minitest::Reporters.use!(
+  [Minitest::Reporters::CustomReporter.new(reporter_options)]
+)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smtp_lw
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Locaweb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This is the ruby client for SMTP Locaweb product.
 email:
 - desenvolvedores@locaweb.com.br
@@ -145,9 +159,11 @@ extra_rdoc_files: []
 files:
 - ".env.sample"
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
+- CONTRIBUTING.md
 - Gemfile
-- LICENSE.txt
+- LICENSE
 - README.md
 - Rakefile
 - lib/smtp_lw.rb
@@ -157,6 +173,9 @@ files:
 - lib/smtp_lw/default.rb
 - lib/smtp_lw/version.rb
 - smtp_lw.gemspec
+- test/fixtures/test_0001_find_messages_with_required_filters.yml
+- test/fixtures/test_0002_will_send_a_message.yml
+- test/fixtures/test_0003_returns_a_message.yml
 - test/lib/smtp_lw/client/messages_test.rb
 - test/lib/smtp_lw/client_test.rb
 - test/lib/smtp_lw/configurable_test.rb
@@ -183,14 +202,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: This is the ruby client for SMTP Locaweb product.
 test_files:
+- test/fixtures/test_0001_find_messages_with_required_filters.yml
+- test/fixtures/test_0002_will_send_a_message.yml
+- test/fixtures/test_0003_returns_a_message.yml
 - test/lib/smtp_lw/client/messages_test.rb
 - test/lib/smtp_lw/client_test.rb
 - test/lib/smtp_lw/configurable_test.rb
 - test/lib/smtp_lw/default_test.rb
 - test/lib/smtp_lw/version_test.rb
 - test/test_helper.rb
+has_rdoc: