smtp_lw 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4fdd978d2fc692d4534cbe4238a32e123a867f2
+  data.tar.gz: 67ab29002efa96217c1bf518814d5cf5d89a41d5
+SHA512:
+  metadata.gz: 7a25046824b51f6243f40da8dce0ac72ed57f9e62146ee53fc87474cd1ce2640e5f950532c8d5cf55dee91d017381c4cb620a1f4988c40afe9a357a754c9911b
+  data.tar.gz: ee26d79bd8d10fb49e9f0e435b872ce6914f03526cc63d7b703cc682c4fe91e8214aec124bac2e52526f56528e68272b1c7273fd6257cf2594f0288368a631fe

data/.env.sample

@@ -0,0 +1,2 @@
+# Authentication info
+SMTP_LW_API_TOKEN='colar o token do painel'

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env
+test/fixtures/*.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rachad Honein
+
+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

@@ -0,0 +1,72 @@
+# SmtpLw
+
+This is the ruby client for SMTP Locaweb product.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smtp_lw'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smtp_lw
+
+## Usage
+
+### Authentication and Configuration
+```ruby
+client = SmtpLw::Client.new(api_token: 'your api token from the panel')
+```
+
+or
+
+```ruby
+SmtpLw.configure do |c|
+  c.api_token = 'your api token'
+  c.per_page = 50
+end
+
+# instanciate the client
+client = SmtpLw::Client.new
+```
+
+Alternatively you can authenticate setting an ENV: 
+
+```
+SMTP_LW_API_TOKEN='your api token'
+```
+and then:
+```ruby
+client = SmtpLw::Client.new
+```
+
+### Get the list of messages
+
+```ruby
+client.list_messages('all', '2015-07-01', '2015-07-30')
+```
+You can pass options as specified in the API documentation:
+```ruby
+client.list_messages('all', '2015-07-01', '2015-07-30' {page: 1, per: 50})
+```
+
+### Send a message
+```ruby
+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

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/smtp_lw'
+  t.test_files = FileList['test/lib/smtp_lw/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test
+

data/lib/smtp_lw.rb

@@ -0,0 +1,10 @@
+module SmtpLw
+  require "smtp_lw/version"
+  require "smtp_lw/default"
+  require "smtp_lw/configurable"
+  require "smtp_lw/client"
+  class << self
+    include SmtpLw::Configurable
+  end
+
+end

data/lib/smtp_lw/client.rb

@@ -0,0 +1,72 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'smtp_lw/client/messages'
+
+module SmtpLw
+  class Client
+    attr_accessor :api_token, :api_endpoint, :per_page, :timeout
+    include SmtpLw::Client::Messages
+
+    def initialize(options={})
+      SmtpLw::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", options[key] || SmtpLw.instance_variable_get(:"@#{key}"))
+      end
+    end
+
+    # Make a HTTP GET request
+    #
+    # @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
+    end
+
+    # Make a HTTP POST request
+    #
+    # @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
+    end
+
+    # Make a HTTP PUT request
+    #
+    # @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
+    end
+
+    def next_page(raw)
+      next_uri = raw["links"]["next"]
+      return nil unless next_uri
+      response = connection.get next_uri
+      return response.body
+    end
+
+    private
+
+    def paginate(options)
+      page = options[:page] || 1
+      per = options[:per] || SmtpLw.per_page
+      options.merge(page: page, per: per)
+    end
+
+    def connection
+      conn = Faraday.new(url: 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'] = SmtpLw.api_token
+      conn
+    end
+
+  end
+end

data/lib/smtp_lw/client/messages.rb

@@ -0,0 +1,16 @@
+module SmtpLw
+  class Client
+    module Messages
+
+      def list_messages(status, start_date, end_date, options={})
+        res = get "messages/", options.merge({status: status, start_date: start_date, end_date: end_date})
+        res.body
+      end
+
+      def send_message(subject, body, from, to, options={})
+        res = post "messages", options.merge({subject: subject, body: body, from: from, to: to})
+        res.body
+      end
+    end
+  end
+end

data/lib/smtp_lw/configurable.rb

@@ -0,0 +1,49 @@
+module SmtpLw
+  module Configurable
+    attr_accessor :api_token, :api_endpoint, :per_page, :timeout
+
+    class << self
+      def keys
+        @keys ||= [
+          :api_token,
+          :api_endpoint,
+          :per_page,
+          :timeout
+        ]
+      end
+    end
+
+    def api_token
+      @api_token || SmtpLw::Default.api_token
+    end
+
+    # Base endpoint URL for generated web URLs
+    # Referenced by SmtpLw.api_endpoint
+    # @return [String] Default: https://api.smtplw.com.br/v1/
+    def api_endpoint
+      @api_endpoint || SmtpLw::Default.api_endpoint
+    end
+
+    def per_page
+      @per_page || SmtpLw::Default.per_page
+    end
+
+    def timeout
+      @timeout || SmtpLw::Default.timeout
+    end
+
+    # Set configuration options using a block
+    def configure
+      yield self
+    end
+
+    def reset!
+      SmtpLw::Configurable.keys.each do |key|
+        instance_variable_set(:"@#{key}", SmtpLw::Default.options[key])
+      end
+      self
+    end
+
+  end
+end
+

data/lib/smtp_lw/default.rb

@@ -0,0 +1,37 @@
+module SmtpLw
+  module Default
+    API_BASE = "https://api.smtplw.com.br".freeze
+    API_VERSION = "/v1/".freeze
+
+    class << self
+      def api_endpoint
+        ENV['SMTP_LW_API_ENDPOINT'] || (API_BASE + API_VERSION)
+      end
+
+      def api_token
+        ENV['SMTP_LW_API_TOKEN']
+      end
+
+      def api_version
+        API_VERSION
+      end
+
+      def api_base
+        ENV['SMTP_LW_API_BASE'] || API_BASE
+      end
+
+      def options
+        Hash[SmtpLw::Configurable.keys.map{|key| [key, send(key)]}]
+      end
+
+      # used for pagination when available on get
+      def per_page
+        ENV['SMTP_LW_PER_PAGE'] || 100
+      end
+
+      def timeout
+        ENV['SMTP_LW_TIMEOUT'] || 5
+      end
+    end
+  end
+end

data/lib/smtp_lw/version.rb

@@ -0,0 +1,3 @@
+module SmtpLw
+  VERSION = "0.0.1"
+end

data/smtp_lw.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smtp_lw/version'
+
+Gem::Specification.new do |spec|
+  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      = "http://locaweb.com.br"
+  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.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+
+  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 "dotenv"
+  spec.add_development_dependency "minitest-reporters"
+end

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

@@ -0,0 +1,25 @@
+require_relative '../../../test_helper'
+
+describe SmtpLw::Client::Messages do
+
+  subject { SmtpLw::Client.new }
+
+  before do
+    VCR.insert_cassette name
+  end
+
+  after 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
+  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')
+    assert_equal raw['data']['attributes']['status'], 'Enfileirado'
+  end
+end
+

data/test/lib/smtp_lw/client_test.rb

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

data/test/lib/smtp_lw/configurable_test.rb

@@ -0,0 +1,20 @@
+require_relative '../../test_helper'
+
+describe SmtpLw 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
+    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

@@ -0,0 +1,9 @@
+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/"
+  end
+
+end

data/test/lib/smtp_lw/version_test.rb

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

data/test/test_helper.rb

@@ -0,0 +1,64 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/reporters'
+require 'byebug'
+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"
+  c.hook_into :webmock
+  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'
+end
+
+module Minitest
+  module Reporters
+    class CustomReporter < DefaultReporter
+      GRAY = '0;36'
+      GREEN = '1;32'
+      RED = '1;31'
+
+      def initialize(options = {})
+        super
+        @slow_threshold = options.fetch(:slow_threshold, nil)
+      end
+
+      def record_pass(test)
+        if @slow_threshold.nil? || test.time <= @slow_threshold
+          super
+        else
+          gray('O')
+        end
+      end
+
+      def color_up(string, color)
+        color? ? "\e\[#{ color }m#{ string }#{ ANSI::Code::ENDCODE }" : string
+      end
+
+      def red(string)
+        color_up(string, RED)
+      end
+
+      def green(string)
+        color_up(string, GREEN)
+      end
+
+      def gray(string)
+        color_up(string, GRAY)
+      end
+    end
+  end
+end
+
+reporter_options = { color: true, slow_count: 5 }
+Minitest::Reporters.use! [Minitest::Reporters::CustomReporter.new(reporter_options)]

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: smtp_lw
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Locaweb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.sample"
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smtp_lw.rb
+- lib/smtp_lw/client.rb
+- lib/smtp_lw/client/messages.rb
+- lib/smtp_lw/configurable.rb
+- lib/smtp_lw/default.rb
+- lib/smtp_lw/version.rb
+- smtp_lw.gemspec
+- 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
+homepage: http://locaweb.com.br
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: This is the ruby client for SMTP Locaweb product.
+test_files:
+- 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