infosimples-data 1.9.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cafc3657b7756d7c8d0fe8eb9d22e86960807fe7386c0c260eae0c1d57fd0264
+  data.tar.gz: e122aa869af811bd1c253c1bde7765fcd5d04978ef0fedc269151e6ab888dc68
+SHA512:
+  metadata.gz: 641f9b9336802a6c6372ade60cfa698d89bf7615625a595da84108f83e467327ce0f0c8aeb645f16734a36a96b64e8bde14e97dc5969832bdac06aa790139d2b
+  data.tar.gz: f0bc464099cfe36c24c41aa9bd1a408b05f0d3770a0d390bd2e03e586fec6766922a8904a9720a5e1d8c33a1e4b58373f794725919806b75eca40e805b6c7858

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/secrets.yml
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# CHANGELOG
+
+### [1.9.3] - 2018-10-08
+
+# Added
+- GEM created

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in infosimples-data.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    infosimples-data (1.9.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  infosimples-data!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Infosimples
+
+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,112 @@
+# Infosimples::Data
+
+Ruby API for Infosimples::Data (https://infosimples.com/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'infosimples-data'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install infosimples-data
+
+## Usage
+
+1. **Create a client**
+
+  ```ruby
+  require 'infosimples/data'
+  client = Infosimples::Data::Client.new('my_token')
+  ```
+
+2. **Automate a service**
+
+  ```ruby
+  response = client.automate('correios/cep', cep: '01311915')
+  response['code']                  # 200
+  response['code_message']          # "A consulta foi realizada com sucesso e retornou um resultado."
+  response['data']                  # Information about the postal code
+  response['receipt']['sites_urls'] # Links for the original HTMLs.
+
+  client.download_sites_urls(response) # Array with HTML bodies for `sites_urls`.
+  ```
+
+  > Check the full response in our documentation:
+  > https://data.infosimples.com/docs
+
+3. **Billing**
+
+  ```ruby
+  billing = client.billing          # Array of Hashes with:
+  billing.first['name']             # - Name of the Token
+  billing.first['quantity']         # - Number of automation requests the token has made
+  billing.first['credits']          # - How many credits the token has used
+  ```
+
+4. **Pricing**
+
+  ```ruby
+  pricing = client.pricing          # Array of Hashes with:
+  pricing.first['service']          # - Name of the service that can be automated
+  pricing.first['credits']          # - How many credits this service uses
+  ```
+
+5. **Response codes**
+
+  ```ruby
+  # Check a response code:
+  response['code'] == Infosimples::Data::CODE[:single_result]
+
+  # List of codes
+  {
+    # success
+    single_result:          200,
+    multiple_results:       201,
+
+    # error
+    unexpected_error:       600,
+    unauthorized:           601,
+    invalid_service:        602,
+    forbidden:              603,
+    invalid_request:        604,
+    timeout:                605,
+    empty_parameters:       606,
+    invalid_parameters:     607,
+    refused_parameters:     608,
+    attempts_exceeded:      609,
+    failed_captcha:         610,
+    incomplete_data:        611,
+    inexistent:             612,
+    blocked_request:        613,
+    try_again:              614,
+    source_unavailable:     615,
+    source_error:           616,
+    service_overloaded:     617,
+    rate_limit_exceeded:    618,
+    converted_parameters:   619,
+    permanent_error:        620,
+    receipt_error:          621,
+  }
+  ```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/infosimples/infosimples-data.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "infosimples/data"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/infosimples-data.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "infosimples/data/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "infosimples-data"
+  spec.version       = Infosimples::Data::VERSION
+  spec.authors       = ["Infosimples"]
+  spec.email         = ["team@infosimples.com.br"]
+
+  spec.summary       = %q{Ruby API for Infosimples::Data (https://infosimples.com/)}
+  spec.description   = %q{Infosimples::Data allows you to automate web site navigation.}
+  spec.homepage      = "https://github.com/infosimples/infosimples-data"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/infosimples/data.rb

@@ -0,0 +1,20 @@
+require 'net/http'
+require 'openssl/cipher'
+require 'digest/sha2'
+require 'base64'
+require 'json'
+
+module Infosimples
+  module Data
+    def self.new(token, args = {})
+      Infosimples::Data::Client.new(token, args)
+    end
+  end
+end
+
+require 'infosimples/data/client'
+require 'infosimples/data/code'
+require 'infosimples/data/errors'
+require 'infosimples/data/http'
+require 'infosimples/data/symmetric_encryption'
+require 'infosimples/data/version'

data/lib/infosimples/data/client.rb

@@ -0,0 +1,105 @@
+module Infosimples::Data
+  # Infosimples::Data::Client is a client for the Infosimples Data API.
+  class Client
+    BASE_URL = 'https://data.infosimples.com/api/v1/:service.json'
+    ENCRYPTABLE_ARGS = ['pkcs12_cert', 'pkcs12_pass', 'pass'].map {
+      |arg| [arg, true]
+    }.to_h
+
+    attr_accessor :token, :timeout, :max_age
+
+    # Create a Infosimples::Data API client.
+    #
+    # @param [String] token    Your access token.
+    # @param [Hash]   options  Options hash.
+    # @option options [Integer] :timeout (120)   Seconds before giving up of an
+    #                                            automation being completed.
+    # @option options [Integer] :max_age (86400) Duration in seconds for a
+    #                                            cached automation to be
+    #                                            allowed.
+    #
+    # @return [Infosimples::Data::Client] A Client instance.
+    def initialize(token, options = {})
+      self.token    = token
+      self.timeout  = options[:timeout] || 120   # 120 seconds
+      self.max_age  = options[:max_age] || 86400 # 24 hours in seconds
+    end
+
+    # Automate a service.
+    #
+    # @param [String] service   Service you want to automate.
+    # @param [Hash]   args      Arguments to be used in the service automation.
+    #
+    # @return [Hash] Response according to https://data.infosimples.com/docs.
+    def automate(service, args = {})
+      args.keys.each do |key|
+        if ENCRYPTABLE_ARGS[key.to_s]
+          args[key] = encrypt(args[key])
+        end
+      end
+      request(service, :multipart, args)
+    end
+
+    # Get billing statistics from your account.
+    #
+    # @return [Array] Billing statistics per token.
+    def billing
+      request('billing', :get)
+    end
+
+    # Get prices for each service.
+    #
+    # @return [Array] Service with price.
+    def pricing
+      request('pricing', :get)
+    end
+
+    # Download sites_urls from response.
+    #
+    # @param [Hash] response  Response returned by #automate.
+    #
+    # @return [Array] HTML bodies from sites_urls.
+    def download_sites_urls(response)
+      return [] if !response.is_a?(Hash) ||
+                   (sites_urls = response.dig('receipt', 'sites_urls')).nil?
+      sites_urls.map do |url|
+        Infosimples::Data::HTTP.request(url: url, http_timeout: 30)
+      end
+    end
+
+    private
+
+    # Apply symmetric encryption to data.
+    #
+    # @param [String] data The original data that will be encrypted.
+    #
+    # @return [String] encrypted data.
+    def encrypt(data)
+      @crypt ||= Infosimples::Data::SymmetricEncryption.new(token)
+      @crypt.encrypt(data)
+    end
+
+    # Perform an HTTP request to the Infosimples Data API.
+    #
+    # @param [String] service  API method name.
+    # @param [Symbol] method   HTTP method (:get, :post, :multipart).
+    # @param [Hash]   payload  Data to be sent through the HTTP request.
+    #
+    # @return [Hash] Parsed JSON from the API response.
+    #
+    def request(service, method = :get, payload = {})
+      res = Infosimples::Data::HTTP.request(
+        url: BASE_URL.gsub(':service', service),
+        http_timeout: timeout,
+        method: method,
+        payload: payload.merge(
+          token:   token,
+          timeout: timeout,
+          max_age: max_age,
+          header:  1
+        )
+      )
+      JSON.parse(res)
+    end
+  end
+end

data/lib/infosimples/data/code.rb

@@ -0,0 +1,31 @@
+module Infosimples::Data
+  CODE = {
+    # success
+    single_result:          200,
+    multiple_results:       201,
+
+    # error
+    unexpected_error:       600,
+    unauthorized:           601,
+    invalid_service:        602,
+    forbidden:              603,
+    invalid_request:        604,
+    timeout:                605,
+    empty_parameters:       606,
+    invalid_parameters:     607,
+    refused_parameters:     608,
+    attempts_exceeded:      609,
+    failed_captcha:         610,
+    incomplete_data:        611,
+    inexistent:             612,
+    blocked_request:        613,
+    try_again:              614,
+    source_unavailable:     615,
+    source_error:           616,
+    service_overloaded:     617,
+    rate_limit_exceeded:    618,
+    converted_parameters:   619,
+    permanent_error:        620,
+    receipt_error:          621,
+  }
+end

data/lib/infosimples/data/errors.rb

@@ -0,0 +1,16 @@
+module Infosimples::Data
+
+  # This is our base Error class. Rescue `Infosimples::Data::Error` if you want
+  # to catch any known exception related to this gem.
+  class Error < Exception
+  end
+
+  class ArgumentError < Error
+  end
+
+  class Timeout < Error
+    def initialize
+      super('The request was not processed in the expected time')
+    end
+  end
+end

data/lib/infosimples/data/http.rb

@@ -0,0 +1,76 @@
+module Infosimples::Data
+  # Infosimples::Data::HTTP exposes common HTTP routines that can be used by the
+  # Infosimples::Data API client.
+  #
+  class HTTP
+    # Perform an HTTP request with support for multipart requests.
+    #
+    # @param [Hash] options Options hash.
+    # @param options [String] url      URL to be requested.
+    # @param options [Symbol] method   HTTP method (:get, :post, :multipart).
+    # @param options [Hash]   payload  Data to be sent through the HTTP request.
+    # @param options [Integer] http_timeout HTTP open/read timeout in seconds.
+    #
+    # @return [String] Response body of the HTTP request.
+    #
+    def self.request(options = {})
+      uri     = URI(options[:url])
+      method  = options[:method] || :get
+      payload = options[:payload] || {}
+      timeout = options[:http_timeout]
+      headers = { 'User-Agent' => Infosimples::Data::USER_AGENT }
+
+      case method
+      when :get
+        uri.query = URI.encode_www_form(payload)
+        req = Net::HTTP::Get.new(uri.request_uri, headers)
+
+      when :post
+        req = Net::HTTP::Post.new(uri.request_uri, headers)
+        req.set_form_data(payload)
+
+      when :multipart
+        req = Net::HTTP::Post.new(uri.request_uri, headers)
+        boundary, body = prepare_multipart_data(payload)
+        req.content_type = "multipart/form-data; boundary=#{boundary}"
+        req.body = body
+
+      else
+        fail Infosimples::Data::ArgumentError, "Illegal HTTP method (#{method})"
+      end
+
+      http = Net::HTTP.new(uri.hostname, uri.port)
+      http.use_ssl = true if (uri.scheme == 'https')
+      http.open_timeout = timeout
+      http.read_timeout = timeout + 10
+      http.max_retries = 0 # default is max_retries = 1
+      res = http.request(req)
+      res.body
+
+    rescue Net::OpenTimeout, Net::ReadTimeout
+      raise Infosimples::Data::Timeout
+    end
+
+    # Prepare the multipart data to be sent via a :multipart request.
+    #
+    # @param [Hash] payload Data to be prepared via a multipart post.
+    #
+    # @return [String, String] Boundary and body for the multipart post.
+    #
+    def self.prepare_multipart_data(payload)
+      boundary = 'randomstr' + rand(1_000_000).to_s # a random unique string
+
+      content = []
+      payload.each do |param, value|
+        content << '--' + boundary
+        content << "Content-Disposition: form-data; name=\"#{param}\""
+        content << ''
+        content << value
+      end
+      content << '--' + boundary + '--'
+      content << ''
+
+      [boundary, content.join("\r\n")]
+    end
+  end
+end

data/lib/infosimples/data/symmetric_encryption.rb

@@ -0,0 +1,25 @@
+module Infosimples::Data
+  class SymmetricEncryption
+    attr_accessor :key
+    def initialize(key)
+      fail("INVALID KEY SIZE: #{key}") if key.size < 32
+      self.key = key[0,32]
+    end
+
+    def encrypt(data, to_base64=true)
+      aes = OpenSSL::Cipher.new('AES-256-CBC')
+      aes.encrypt
+      aes.key = Digest::SHA256.digest(key)
+      encrypted_data = aes.update(data) + aes.final
+      to_base64 ? Base64.encode64(encrypted_data) : encrypted_data
+    end
+
+    def decrypt(data, from_base64=true)
+      data = Base64.decode64(data) if from_base64
+      aes = OpenSSL::Cipher.new('AES-256-CBC')
+      aes.decrypt
+      aes.key = Digest::SHA256.digest(key)
+      aes.update(data) + aes.final
+    end
+  end
+end

data/lib/infosimples/data/version.rb

@@ -0,0 +1,6 @@
+module Infosimples
+  module Data
+    VERSION = "1.9.4" # https://data.infosimples.com/docs/changelog
+    USER_AGENT = "Infosimples::Data/Ruby v#{VERSION}"
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: infosimples-data
+version: !ruby/object:Gem::Version
+  version: 1.9.4
+platform: ruby
+authors:
+- Infosimples
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Infosimples::Data allows you to automate web site navigation.
+email:
+- team@infosimples.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- infosimples-data.gemspec
+- lib/infosimples/data.rb
+- lib/infosimples/data/client.rb
+- lib/infosimples/data/code.rb
+- lib/infosimples/data/errors.rb
+- lib/infosimples/data/http.rb
+- lib/infosimples/data/symmetric_encryption.rb
+- lib/infosimples/data/version.rb
+homepage: https://github.com/infosimples/infosimples-data
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Ruby API for Infosimples::Data (https://infosimples.com/)
+test_files: []