portatext 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50ede6f538968f483c1cbb537ac84e9f88745f41
+  data.tar.gz: a24b867a6f1d19153295d2882b4c3f9ef5751bad
+SHA512:
+  metadata.gz: 2a0dda3ef83a228e9d14ca5a906b6ad1c4a5f9ca33bede9aa88512579af405aca5f11b3b95a99e47dd2a909e1513cd6960778f4628fc8a578bb73a082eb7b831
+  data.tar.gz: 77ccb360a42737f6c13a46ef897c4f4cb5b54182cb14dfdcaae064c2e00b9aed9e0f1780cad64a5975402a2db7fef7e3d5684d3438b151e2e90586bc13f349ab

data/.codeclimate.yml

@@ -0,0 +1,25 @@
+---
+engines:
+  bundler-audit:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: false
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- test/**/*

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+coverage
+*.gem

data/.rubocop.yml

@@ -0,0 +1,7 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - 'src/**/*'
+  Exclude:
+    - 'test/**/*'
+

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6
+addons:
+  code_climate:
+    repo_token: 2949b385b49f033864d017ee2a530cb3a1ff12b332be2433fb16abe4b794425e

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,178 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+

data/README.md

@@ -0,0 +1,150 @@
+[![License](http://img.shields.io/badge/license-APACHE2-blue.svg)](http://img.shields.io/badge/license-APACHE2-blue.svg)
+[![Gem Version](https://badge.fury.io/rb/portatext.svg)](https://badge.fury.io/rb/portatext)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/portatext/ruby-sdk/master/frames)
+
+[![Build Status](https://travis-ci.org/PortaText/ruby-sdk.svg)](https://travis-ci.org/PortaText/ruby-sdk)
+[![Coverage Status](https://coveralls.io/repos/PortaText/ruby-sdk/badge.svg?branch=master&service=github)](https://coveralls.io/github/PortaText/ruby-sdk?branch=master)
+[![Code Climate](https://codeclimate.com/github/PortaText/ruby-sdk/badges/gpa.svg)](https://codeclimate.com/github/PortaText/ruby-sdk)
+[![Issue Count](https://codeclimate.com/github/PortaText/ruby-sdk/badges/issue_count.svg)](https://codeclimate.com/github/PortaText/ruby-sdk)
+[![Inline docs](http://inch-ci.org/github/portatext/ruby-sdk.svg?branch=master)](http://inch-ci.org/github/portatext/ruby-sdk)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/remote-exec/command-designer/master/frames)
+# ruby-sdk
+Official Ruby Client for the [PortaText](https://www.portatext.com/) API.
+
+# Documentation
+
+* The [endpoint tests](https://github.com/PortaText/ruby-sdk/tree/master/test/endpoints) should also serve as good doucmentation on how to use the API.
+* General PortaText documentation (including the REST API) can be found at the [PortaText wiki](https://github.com/PortaText/docs/wiki).
+
+# Installing
+Add this library to your [Gemfile](http://bundler.io/gemfile.html).
+```ruby
+gem 'portatext'
+```
+
+# Basic use
+
+## Getting a client instance
+The first thing is to get a [Client](https://github.com/PortaText/ruby-sdk/blob/master/lib/portatext/client/base_client.rb) instance, for example
+the [Net::HTTP](https://github.com/PortaText/ruby-sdk/blob/master/lib/portatext/client/http_client.rb) implementation:
+
+```ruby
+require 'portatext'
+client = PortaText::Client::HttpClient.new
+```
+
+## (Optional) Set your logger
+You can optionally set a [Logger](http://ruby-doc.org/stdlib-2.2.0/libdoc/logger/rdoc/Logger.html) compatible logger:
+```ruby
+client.logger = my_logger
+```
+
+By default, the client will use a logger pointing to `/dev/null`
+
+## Authenticating
+You can authenticate to the endpoints by using your [API key](https://github.com/PortaText/docs/wiki/REST-API#auth_api) or your username/password. This translates to
+either doing this:
+
+```ruby
+client.api_key = api_key
+```
+
+Or this:
+
+```ruby
+client.credentials = [username, password]
+```
+
+When you specify a [username and password](https://github.com/PortaText/docs/wiki/REST-API#auth_basic) instead of an api key, the sdk will
+automatically login and get a [session token](https://github.com/PortaText/docs/wiki/REST-API#auth_session) when needed.
+
+# Using the endpoints
+All the API commands can be found in the [command/api](https://github.com/PortaText/ruby-sdk/tree/master/lib/portatext/command/api)
+directory. The client offers a way to instantiate them by just calling them by their name.
+
+## Quick example
+As an example, to create a template, you would do:
+
+```ruby
+result = client
+  .templates                       # Get an instance of the Templates endpoint.
+  .text('The text of my template')
+  .description('My first template')
+  .name('template1')
+  .post                            # Call the Templates endpoint with a POST.
+```
+
+To get a template by id:
+
+```ruby
+result = client.templates.id(45).get
+```
+
+Or, to get all the templates:
+
+```ruby
+result = client.templates.get
+```
+
+## The result
+After calling an endpoint, one of two things can happen:
+ * A [PortaText Exception](https://github.com/PortaText/ruby-sdk/tree/master/lib/portatext/exception) is raised.
+ * A [Result](https://github.com/PortaText/ruby-sdk/blob/master/lib/portatext/command/result.rb) instance is returned.
+
+Also, when possible, your PortaText exception will contain a `Result` object that
+can be retrieved by using the `result` accessor on the exception. This is usually useful for the
+[ClientError](https://github.com/PortaText/ruby-sdk/blob/master/lib/portatext/exception/client_error.rb) exception, where
+you will be able to see if a field was missing or different than what was expected.
+
+### Testing for success
+```ruby
+if result.success?
+    ...
+end
+```
+
+### Getting error strings back from the server
+```ruby
+if !result.errors.nil?
+  result.errors.each do |e|
+    puts e
+  end
+end
+```
+
+### Getting data back from the server
+```ruby
+if result.success
+  data = result.data
+end
+```
+
+# Developers
+This project uses [rake](https://github.com/ruby/rake). Current tasks include:
+ * test: Runs [MiniTest](https://github.com/seattlerb/minitest)s.
+ * rubocop: Runs [RuboCop](https://github.com/bbatsov/rubocop).
+ * default: This is the default task, and will run all the other tasks.
+
+## Running a rake task
+To run a task, just do:
+
+```sh
+rake test
+```
+
+## Contributing
+To contribute:
+ * Make sure you open a **concise** and **short** pull request.
+ * Throw in any needed unit tests to accomodate the new code or the
+ changes involved.
+ * Run `rake` and make sure everything is ok before submitting the pull
+ request (make rubocop happy).
+ * Your code must comply with [the GitHub ruby style](https://github.com/styleguide/ruby).
+ * If your code is accepted, it will belong to PortaText and will be published
+ under the Apache2 License.
+
+# License
+The source code is released under Apache 2 License.
+
+Check [LICENSE](https://github.com/PortaText/ruby-sdk/blob/master/LICENSE) file for more information.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: [:rubocop, :test]

data/lib/portatext/client/base_client.rb

@@ -0,0 +1,114 @@
+require 'logger'
+require 'base64'
+
+module PortaText
+  module Client
+    # A generic PortaText client.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class BaseClient
+      attr_writer :endpoint
+      attr_writer :api_key
+      attr_writer :credentials
+      attr_writer :executor
+      attr_writer :logger
+
+      def method_missing(method, *_arguments, &_block)
+        method = method.to_s.split('_').map(&:capitalize)
+        name = "PortaText::Command::Api::#{method.join('')}"
+        class_name = Object.const_get name
+        class_name.new self
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      # rubocop:disable Metrics/AbcSize
+      def run(endpoint, method, content_type, body, auth = nil)
+        true_endpoint = "#{@endpoint}/#{endpoint}"
+        auth ||= auth_method(auth)
+        headers = form_headers content_type, auth
+        @logger.debug "Calling #{method} #{true_endpoint} with #{auth}"
+        descriptor = PortaText::Command::Descriptor.new(
+          true_endpoint, method, headers, body
+        )
+        ret_code, ret_headers, ret_body = @executor.execute descriptor
+        result = PortaText::Command::Result.new(
+          ret_code, ret_headers, JSON.parse(ret_body)
+        )
+        if ret_code.eql?(401) && auth.eql?(:session_token)
+          login!
+          result = run endpoint, method, content_type, body
+        end
+        assert_result descriptor, result
+      end
+      # rubocop:enable Metrics/MethodLength
+      # rubocop:enable Metrics/AbcSize
+
+      def initialize
+        @logger = Logger.new nil
+        @endpoint = DEFAULT_ENDPOINT
+        @api_key = nil
+        @credentials = nil
+        @session_token = nil
+        @executor = self
+      end
+
+      private
+
+      def login!
+        result = run 'login', :post, 'application/json', '', :basic
+        @session_token = result.data['token']
+      end
+
+      def assert_result(descriptor, result)
+        error = error_for result.code
+        return result if error.nil?
+        fail error, [descriptor, result]
+      end
+
+      def auth_method(auth_suggested)
+        return auth_suggested unless auth_suggested.nil?
+        return :session_token unless @session_token.nil?
+        return :api_key unless @api_key.nil?
+        login!
+        :session_token
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def error_for(code)
+        errors = {
+          400 => PortaText::Exception::ClientError,
+          401 => PortaText::Exception::InvalidCredentials,
+          402 => PortaText::Exception::PaymentRequired,
+          403 => PortaText::Exception::Forbidden,
+          404 => PortaText::Exception::NotFound,
+          405 => PortaText::Exception::InvalidMethod,
+          415 => PortaText::Exception::InvalidMedia,
+          429 => PortaText::Exception::RateLimited,
+          500 => PortaText::Exception::ServerError
+        }
+        errors[code]
+      end
+
+      def form_headers(content_type, auth)
+        headers = {
+          'Content-Type' => content_type,
+          'Accept' => 'application/json'
+        }
+        case auth
+        when :session_token
+          headers['X-Session-Token'] = @session_token
+        when :basic
+          auth_string = Base64.encode64 "#{@credentials[0]}:#{@credentials[1]}"
+          headers['Authorization'] = "Basic #{auth_string}"
+        when :api_key
+          headers['X-Api-Key'] = @api_key
+        else
+          fail "Invalid auth type: #{auth}"
+        end
+        headers
+      end
+    end
+  end
+end

data/lib/portatext/client/http_client.rb

@@ -0,0 +1,55 @@
+require 'net/http'
+require 'uri'
+require 'openssl'
+
+module PortaText
+  module Client
+    # This class implements the client using Net::HTTP
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class HttpClient < BaseClient
+      def execute(descriptor)
+        uri = URI.parse descriptor.uri
+        http = create_http uri
+        request = create_request uri, descriptor.method, descriptor.body
+        begin
+          request! descriptor, http, request
+        rescue => e
+          raise ::PortaText::Exception::RequestError.new(
+            descriptor, nil, e.message, e
+          )
+        end
+      end
+
+      private
+
+      def create_http(uri)
+        http = Net::HTTP.new uri.host, uri.port
+        http.use_ssl = uri.scheme == 'https'
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        http
+      end
+
+      def create_request(uri, method, body)
+        method = method.to_s.capitalize
+        request = Object.const_get("Net::HTTP::#{method}").new uri
+        request.body = body
+        request
+      end
+
+      def request!(descriptor, http, request)
+        descriptor.headers.each_pair do |k, v|
+          request[k] = v
+        end
+        result = http.request request
+        headers = result.to_hash.each_with_object({}) do |(k, v), acc|
+          acc[k.downcase] = v.shift
+          acc
+        end
+        [result.code.to_i, headers, result.body]
+      end
+    end
+  end
+end

data/lib/portatext/command/api/acl.rb

@@ -0,0 +1,27 @@
+module PortaText
+  module Command
+    module Api
+      # The me/acl endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_acl
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Acl < Base
+        def add(ip, netmask = 32, description = '')
+          key = "#{ip}#{netmask}"
+          set key, ip: ip, netmask: netmask, description: description
+        end
+
+        def body(method)
+          return super if method.eql? :get
+          { acl: @args.values }.to_json
+        end
+
+        def endpoint(_method)
+          'me/acl'
+        end
+      end
+    end
+  end
+end

data/lib/portatext/command/api/credit_cards.rb

@@ -0,0 +1,43 @@
+module PortaText
+  module Command
+    module Api
+      # The me/credit_cards/:id endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_credit_cards
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class CreditCards < Base
+        def id(id)
+          set :id, id
+        end
+
+        def name_on_card(first, last)
+          set :first_name, first
+          set :last_name, last
+        end
+
+        def card_info(number, expiration_date, code)
+          set :card_number, number
+          set :card_expiration_date, expiration_date
+          set :card_code, code
+        end
+
+        def address(street_address, city, state, zip, country)
+          set :address, street_address
+          set :city, city
+          set :state, state
+          set :zip, zip
+          set :country, country
+        end
+
+        def endpoint(_method)
+          return 'me/credit_cards' if @args[:id].nil?
+          id = @args[:id]
+          @args.delete :id
+          "me/credit_cards/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/portatext/command/api/did_settings.rb

@@ -0,0 +1,41 @@
+module PortaText
+  module Command
+    module Api
+      # The me/dids/:did endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_did_settings
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class DidSettings < Base
+        def for_number(number)
+          set :id, number
+        end
+
+        def disable_cnam
+          set :cnam_enabled, false
+        end
+
+        def enable_cnam
+          set :cnam_enabled, true
+        end
+
+        def dont_autorespond
+          set :autoresponder_enabled, false
+        end
+
+        def autorespond_with(text)
+          set :autoresponder_text, text
+          set :autoresponder_enabled, true
+        end
+
+        def endpoint(_method)
+          fail 'DID number cant be null' if @args[:id].nil?
+          id = @args[:id]
+          @args.delete :id
+          "me/dids/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/portatext/command/api/me.rb

@@ -0,0 +1,38 @@
+module PortaText
+  module Command
+    module Api
+      # The me endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_me
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Me < Base
+        def name(first, last)
+          set :first_name, first
+          set :last_name, last
+        end
+
+        def company(company)
+          set :company, company
+        end
+
+        def email(email)
+          set :email, email
+        end
+
+        def callback_url(callback_url)
+          set :callback_url, callback_url
+        end
+
+        def timezone(timezone)
+          set :timezone, timezone
+        end
+
+        def endpoint(_method)
+          'me'
+        end
+      end
+    end
+  end
+end

data/lib/portatext/command/api/settings.rb

@@ -0,0 +1,45 @@
+module PortaText
+  module Command
+    module Api
+      # The me/settings endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_settings
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Settings < Base
+        def dont_alert_on_low_credit
+          set :alert_when_credit_less_than, nil
+        end
+
+        def alert_when_credit_less_than(total)
+          set :alert_when_credit_less_than, total
+        end
+
+        def dont_send_inbound_by_email
+          set :email_on_inbound_sms, nil
+        end
+
+        def send_inbound_by_email(email)
+          set :email_on_inbound_sms, email
+        end
+
+        def enable_autorecharges(when_credit, card_id, plan_id, total)
+          set :autorecharge_enabled, true
+          set :autorecharge_plan_id, plan_id
+          set :autorecharge_card_id, card_id
+          set :autorecharge_total, total
+          set :autorecharge_when_credit, when_credit
+        end
+
+        def disable_autorecharges
+          set :autorecharge_enabled, false
+        end
+
+        def endpoint(_method)
+          'me/settings'
+        end
+      end
+    end
+  end
+end

data/lib/portatext/command/api/tariffs.rb

@@ -0,0 +1,24 @@
+module PortaText
+  module Command
+    module Api
+      # The tariffs endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_tariffs
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Tariffs < Base
+        def for_country(country_iso)
+          set :country, country_iso
+        end
+
+        def endpoint(_method)
+          return 'tariffs' if @args[:country].nil?
+          country = @args[:country]
+          @args.delete :country
+          "tariffs/#{country}"
+        end
+      end
+    end
+  end
+end

data/lib/portatext/command/base.rb

@@ -0,0 +1,57 @@
+require 'json'
+
+module PortaText
+  module Command
+    # The base command class.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class Base
+      def get
+        run :get
+      end
+
+      def post
+        run :post
+      end
+
+      def put
+        run :put
+      end
+
+      def patch
+        run :patch
+      end
+
+      def delete
+        run :delete
+      end
+
+      def set(key, value)
+        @args[key] = value
+        self
+      end
+
+      def content_type(_method)
+        'application/json'
+      end
+
+      def body(_method)
+        return '' if @args.size.eql? 0
+        @args.to_json
+      end
+
+      def initialize(client)
+        @client = client
+        @args = {}
+      end
+
+      private
+
+      def run(method)
+        @client.run endpoint(method), method, content_type(method), body(method)
+      end
+    end
+  end
+end

data/lib/portatext/command/descriptor.rb

@@ -0,0 +1,23 @@
+module PortaText
+  module Command
+    # This class holds the descriptor with the needed information to call an
+    # endpoint.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class Descriptor
+      attr_accessor :uri
+      attr_accessor :method
+      attr_accessor :headers
+      attr_accessor :body
+
+      def initialize(uri, method, headers, body)
+        @uri = uri
+        @method = method
+        @headers = headers
+        @body = body
+      end
+    end
+  end
+end

data/lib/portatext/command/result.rb

@@ -0,0 +1,22 @@
+module PortaText
+  module Command
+    # This class holds the result of calling the endpoint.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class Result
+      attr_accessor :code
+      attr_accessor :headers
+      attr_accessor :data
+      attr_reader :success
+
+      def initialize(code, headers, data)
+        @code = code
+        @headers = headers
+        @data = data
+        @success = code > 199 && code < 300 && data['success']
+      end
+    end
+  end
+end

data/lib/portatext/exception/client_error.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised when the request issued was invalid, HTTP 400.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class ClientError < RequestError
+    end
+  end
+end

data/lib/portatext/exception/forbidden.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised when access was denied to the resource, HTTP 403.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class Forbidden < RequestError
+    end
+  end
+end

data/lib/portatext/exception/invalid_credentials.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised when credentials were invalid HTTP 401.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class InvalidCredentials < RequestError
+    end
+  end
+end

data/lib/portatext/exception/invalid_media.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised on invalid content type for endpoint/method combination HTTP 415.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class InvalidMedia < RequestError
+    end
+  end
+end

data/lib/portatext/exception/invalid_method.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised on invalid endpoint/method combination HTTP 405.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class InvalidMethod < RequestError
+    end
+  end
+end

data/lib/portatext/exception/not_found.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised when the resource was not found HTTP 404.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class NotFound < RequestError
+    end
+  end
+end

data/lib/portatext/exception/payment_required.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised when not enough funds, HTTP 402.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class PaymentRequired < RequestError
+    end
+  end
+end

data/lib/portatext/exception/rate_limited.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised on rate limited by the server, HTTP 429.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class RateLimited < RequestError
+    end
+  end
+end

data/lib/portatext/exception/request_error.rb

@@ -0,0 +1,21 @@
+module PortaText
+  module Exception
+    # Generic endpoint request error
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class RequestError < ::Exception
+      attr_reader :descriptor
+      attr_reader :original
+      attr_reader :result
+
+      def initialize(descriptor, result = nil, message = nil, original = nil)
+        super message
+        @descriptor = descriptor
+        @original = original
+        @result = result
+      end
+    end
+  end
+end

data/lib/portatext/exception/server_error.rb

@@ -0,0 +1,11 @@
+module PortaText
+  module Exception
+    # Raised on server error, HTTP 500.
+    #
+    # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+    # Copyright:: Copyright (c) 2015 PortaText
+    # License::   Apache-2.0
+    class ServerError < RequestError
+    end
+  end
+end

data/lib/portatext.rb

@@ -0,0 +1,30 @@
+require_relative 'portatext/client/base_client'
+require_relative 'portatext/client/http_client'
+require_relative 'portatext/command/descriptor'
+require_relative 'portatext/command/result'
+require_relative 'portatext/command/base'
+require_relative 'portatext/command/api/tariffs'
+require_relative 'portatext/command/api/me'
+require_relative 'portatext/command/api/acl'
+require_relative 'portatext/command/api/settings'
+require_relative 'portatext/command/api/did_settings'
+require_relative 'portatext/command/api/credit_cards'
+require_relative 'portatext/exception/request_error'
+require_relative 'portatext/exception/server_error'
+require_relative 'portatext/exception/rate_limited'
+require_relative 'portatext/exception/invalid_media'
+require_relative 'portatext/exception/invalid_method'
+require_relative 'portatext/exception/not_found'
+require_relative 'portatext/exception/forbidden'
+require_relative 'portatext/exception/payment_required'
+require_relative 'portatext/exception/invalid_credentials'
+require_relative 'portatext/exception/client_error'
+
+# The PortaText namespace.
+#
+# Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+# Copyright:: Copyright (c) 2015 PortaText
+# License::   Apache-2.0
+module PortaText
+  DEFAULT_ENDPOINT = 'https://rest.portatext.com'
+end

data/portatext.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = 'portatext'
+  s.version     = '0.0.2'
+  s.summary     = 'Official PortaText API ruby client'
+  s.description = 'This is the official PortaText API ruby client'
+  s.authors     = ['PortaText']
+  s.email       = 'hello@portatext.com'
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.require_paths = ['lib']
+  s.homepage    = 'http://rubygems.org/gems/portatext'
+  s.license     = 'Apache-2.0'
+  s.add_development_dependency 'simplecov', '~> 0.11'
+  s.add_development_dependency 'coveralls', '~> 0.8'
+  s.add_development_dependency 'bundler', '~> 1.10'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'minitest', '~> 5.8'
+  s.add_development_dependency 'rubocop', '~> 0.35'
+  s.add_development_dependency 'bundler-audit', '~> 0.4'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: portatext
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- PortaText
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: This is the official PortaText API ruby client
+email: hello@portatext.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/portatext.rb
+- lib/portatext/client/base_client.rb
+- lib/portatext/client/http_client.rb
+- lib/portatext/command/api/acl.rb
+- lib/portatext/command/api/credit_cards.rb
+- lib/portatext/command/api/did_settings.rb
+- lib/portatext/command/api/me.rb
+- lib/portatext/command/api/settings.rb
+- lib/portatext/command/api/tariffs.rb
+- lib/portatext/command/base.rb
+- lib/portatext/command/descriptor.rb
+- lib/portatext/command/result.rb
+- lib/portatext/exception/client_error.rb
+- lib/portatext/exception/forbidden.rb
+- lib/portatext/exception/invalid_credentials.rb
+- lib/portatext/exception/invalid_media.rb
+- lib/portatext/exception/invalid_method.rb
+- lib/portatext/exception/not_found.rb
+- lib/portatext/exception/payment_required.rb
+- lib/portatext/exception/rate_limited.rb
+- lib/portatext/exception/request_error.rb
+- lib/portatext/exception/server_error.rb
+- portatext.gemspec
+homepage: http://rubygems.org/gems/portatext
+licenses:
+- Apache-2.0
+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.8
+signing_key: 
+specification_version: 4
+summary: Official PortaText API ruby client
+test_files: []