portatext 0.0.2 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50ede6f538968f483c1cbb537ac84e9f88745f41
-  data.tar.gz: a24b867a6f1d19153295d2882b4c3f9ef5751bad
+  metadata.gz: 32954d59d49430b0f104a0609dd4e9ff9fcdea74
+  data.tar.gz: d18ce7ded936bc34c1ff77ddaa61f6c1dc8dc896
 SHA512:
-  metadata.gz: 2a0dda3ef83a228e9d14ca5a906b6ad1c4a5f9ca33bede9aa88512579af405aca5f11b3b95a99e47dd2a909e1513cd6960778f4628fc8a578bb73a082eb7b831
-  data.tar.gz: 77ccb360a42737f6c13a46ef897c4f4cb5b54182cb14dfdcaae064c2e00b9aed9e0f1780cad64a5975402a2db7fef7e3d5684d3438b151e2e90586bc13f349ab
+  metadata.gz: d95b9c7bd33971d0b47eed960f821498d5e2603cd8656054c4bcf5b6e038fc5d78019dcac80da5500549c6c74bfed746d2e63f1626eda4efe98f19568f437b46
+  data.tar.gz: 3e8f29cbd84e2595e5018f258d45ad116ec83dd4123c0b1b3a8e69c72b6e25e92157be3ffdf3ba1052df9e0504ad5e50eacbc3c1fdd1191c25733cc1a98250a3

data/README.md

@@ -1,13 +1,13 @@
 [![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)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/portatext)
 
 [![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.
 

data/lib/portatext/client/base_client.rb

@@ -19,7 +19,9 @@ module PortaText
         method = method.to_s.split('_').map(&:capitalize)
         name = "PortaText::Command::Api::#{method.join('')}"
         class_name = Object.const_get name
-        class_name.new self
+        command = class_name.new
+        command.client = self
+        command
       end
 
       # rubocop:disable Metrics/MethodLength
@@ -33,6 +35,7 @@ module PortaText
           true_endpoint, method, headers, body
         )
         ret_code, ret_headers, ret_body = @executor.execute descriptor
+        @logger.debug "Got: #{ret_code} / #{ret_headers} / #{ret_body}"
         result = PortaText::Command::Result.new(
           ret_code, ret_headers, JSON.parse(ret_body)
         )

data/lib/portatext/client/http_client.rb

@@ -32,12 +32,21 @@ module PortaText
         http
       end
 
+      # rubocop:disable Metrics/MethodLength
       def create_request(uri, method, body)
         method = method.to_s.capitalize
         request = Object.const_get("Net::HTTP::#{method}").new uri
-        request.body = body
+        data = /^file:(.*)$/.match(body)
+        if data.nil?
+          request.body = body
+        else
+          file = data.captures.shift
+          request.content_length = File.size file
+          request.body_stream = File.open file, 'r'
+        end
         request
       end
+      # rubocop:enable Metrics/MethodLength
 
       def request!(descriptor, http, request)
         descriptor.headers.each_pair do |k, v|

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

@@ -0,0 +1,29 @@
+module PortaText
+  module Command
+    module Api
+      # The blacklist endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_blacklist
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Blacklist < Base
+        def number(number)
+          set :number, number
+        end
+
+        def csv(file)
+          set :file, file
+        end
+
+        def endpoint(_method)
+          return 'blacklist/contacts' unless @args[:file].nil?
+          return 'blacklist' if @args[:number].nil?
+          number = @args[:number]
+          @args.delete :number
+          "blacklist/#{number}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module PortaText
+  module Command
+    module Api
+      # The campaigns/:id/lifecycle endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_campaigns_lifecycle
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class CampaignLifecycle < Base
+        def id(id)
+          set :id, id
+        end
+
+        def start
+          action 'start'
+        end
+
+        def pause
+          action 'pause'
+        end
+
+        def resume
+          action 'resume'
+        end
+
+        def cancel
+          action 'cancel'
+        end
+
+        def endpoint(_method)
+          fail 'Campaign id cant be null' if @args[:id].nil?
+          id = @args[:id]
+          @args.delete :id
+          "campaigns/#{id}/lifecycle"
+        end
+
+        private
+
+        def action(action)
+          set :action, action
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module PortaText
+  module Command
+    module Api
+      # The campaigns endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_campaigns
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Campaigns < Base
+        def id(id)
+          set :id, id
+        end
+
+        def name(name)
+          set :name, name
+        end
+
+        def description(description)
+          set :description, description
+        end
+
+        def from(from)
+          set :from, from
+        end
+
+        def to_contact_lists(contact_lists)
+          set :contact_list_ids, contact_lists
+        end
+
+        def endpoint(_method)
+          return 'campaigns' if @args[:id].nil?
+          id = @args[:id]
+          @args.delete :type
+          @args.delete :id
+          "campaigns/#{id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+module PortaText
+  module Command
+    module Api
+      # The cnam endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_cnam
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Cnam < Base
+        def for_number(number)
+          set :number, number
+        end
+
+        def endpoint(_method)
+          fail 'DID number cant be null' if @args[:number].nil?
+          number = @args[:number]
+          @args.delete :number
+          "cnam/#{number}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module PortaText
+  module Command
+    module Api
+      # The contact_lists endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_contact_lists
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class ContactLists < Base
+        def id(id)
+          set :id, id
+        end
+
+        def name(name)
+          set :name, name
+        end
+
+        def description(description)
+          set :description, description
+        end
+
+        def csv(file)
+          set :file, file
+        end
+
+        def endpoint(_method)
+          return 'contact_lists' if @args[:id].nil?
+          id = @args[:id]
+          @args.delete :id
+          return "contact_lists/#{id}/contacts" unless @args[:file].nil?
+          "contact_lists/#{id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module PortaText
+  module Command
+    module Api
+      # The dids/search endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_dids_search
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class DidSearch < Base
+        def for_country(iso_code)
+          set :country, iso_code
+        end
+
+        def toll_free
+          type 'toll_free'
+        end
+
+        def local
+          type 'local'
+        end
+
+        def national
+          type 'national'
+        end
+
+        def mobile
+          type 'mobile'
+        end
+
+        def page(page)
+          set :page, page
+        end
+
+        def starts_with(pattern)
+          with_pattern 'starts_with', pattern
+        end
+
+        def ends_with(pattern)
+          with_pattern 'ends_with', pattern
+        end
+
+        def contains(pattern)
+          with_pattern 'anywhere', pattern
+        end
+
+        def body(_method)
+          ''
+        end
+
+        def endpoint(_method)
+          qs = URI.encode_www_form @args
+          "dids/search?#{qs}"
+        end
+
+        private
+
+        def type(type)
+          set :type, type
+        end
+
+        def with_pattern(type, pattern)
+          set :where_pattern, type
+          set :pattern, pattern
+        end
+      end
+    end
+  end
+end

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

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

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

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

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

@@ -0,0 +1,26 @@
+module PortaText
+  module Command
+    module Api
+      # The recharge endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_recharge
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Recharge < Base
+        def with_card(card_id)
+          set :card_id, card_id
+        end
+
+        def total(plan_id, total)
+          set :plan_id, plan_id
+          set :total, total
+        end
+
+        def endpoint(_method)
+          'recharge'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module PortaText
+  module Command
+    module Api
+      # The sms endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_sms
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Sms < Base
+        def id(id)
+          set :id, id
+        end
+
+        def to(to)
+          set :to, to
+        end
+
+        def from(from)
+          set :from, from
+        end
+
+        def use_template(id, variables = {})
+          set :template_id, id
+          set :variables, variables
+        end
+
+        def text(text)
+          set :text, text
+        end
+
+        def client_ref(client_ref)
+          set :client_ref, client_ref
+        end
+
+        def endpoint(_method)
+          return 'sms' if @args[:id].nil?
+          id = @args[:id]
+          @args.delete :id
+          "sms/#{id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+module PortaText
+  module Command
+    module Api
+      # An SMS campaign.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_campaigns
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class SmsCampaign < Campaigns
+        def use_template(template_id, variables)
+          set :template_id, template_id
+          set :variables, variables
+        end
+
+        def text(text)
+          set :text, text
+        end
+
+        def initialize
+          super
+          set :type, 'sms'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module PortaText
+  module Command
+    module Api
+      # The templates endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_templates
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Templates < Base
+        def id(id)
+          set :id, id
+        end
+
+        def name(name)
+          set :name, name
+        end
+
+        def description(description)
+          set :description, description
+        end
+
+        def text(text)
+          set :text, text
+        end
+
+        def endpoint(_method)
+          return 'templates' if @args[:id].nil?
+          id = @args[:id]
+          @args.delete :id
+          "templates/#{id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module PortaText
+  module Command
+    module Api
+      # The timezones endpoint.
+      # https://github.com/PortaText/docs/wiki/REST-API#api_timezones
+      #
+      # Author::    Marcelo Gornstein (mailto:marcelog@portatext.com)
+      # Copyright:: Copyright (c) 2015 PortaText
+      # License::   Apache-2.0
+      class Timezones < Base
+        def endpoint(_method)
+          'timezones'
+        end
+      end
+    end
+  end
+end

data/lib/portatext/command/base.rb

@@ -8,6 +8,8 @@ module PortaText
     # Copyright:: Copyright (c) 2015 PortaText
     # License::   Apache-2.0
     class Base
+      attr_writer :client
+
       def get
         run :get
       end
@@ -34,16 +36,17 @@ module PortaText
       end
 
       def content_type(_method)
+        return 'text/csv' unless @args[:file].nil?
         'application/json'
       end
 
       def body(_method)
+        return "file:#{@args[:file]}" unless @args[:file].nil?
         return '' if @args.size.eql? 0
         @args.to_json
       end
 
-      def initialize(client)
-        @client = client
+      def initialize
         @args = {}
       end
 

data/lib/portatext.rb

@@ -1,3 +1,13 @@
+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'
 require_relative 'portatext/client/base_client'
 require_relative 'portatext/client/http_client'
 require_relative 'portatext/command/descriptor'
@@ -9,16 +19,19 @@ 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'
+require_relative 'portatext/command/api/email_verify'
+require_relative 'portatext/command/api/templates'
+require_relative 'portatext/command/api/sms'
+require_relative 'portatext/command/api/timezones'
+require_relative 'portatext/command/api/cnam'
+require_relative 'portatext/command/api/recharge'
+require_relative 'portatext/command/api/jobs'
+require_relative 'portatext/command/api/contact_lists'
+require_relative 'portatext/command/api/did_search'
+require_relative 'portatext/command/api/blacklist'
+require_relative 'portatext/command/api/campaigns'
+require_relative 'portatext/command/api/sms_campaign'
+require_relative 'portatext/command/api/campaign_lifecycle'
 
 # The PortaText namespace.
 #

data/portatext.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'portatext'
-  s.version     = '0.0.2'
+  s.version     = '1.0.0.pre'
   s.summary     = 'Official PortaText API ruby client'
   s.description = 'This is the official PortaText API ruby client'
   s.authors     = ['PortaText']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portatext
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0.pre
 platform: ruby
 authors:
 - PortaText
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2015-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -140,11 +140,24 @@ files:
 - lib/portatext/client/base_client.rb
 - lib/portatext/client/http_client.rb
 - lib/portatext/command/api/acl.rb
+- lib/portatext/command/api/blacklist.rb
+- lib/portatext/command/api/campaign_lifecycle.rb
+- lib/portatext/command/api/campaigns.rb
+- lib/portatext/command/api/cnam.rb
+- lib/portatext/command/api/contact_lists.rb
 - lib/portatext/command/api/credit_cards.rb
+- lib/portatext/command/api/did_search.rb
 - lib/portatext/command/api/did_settings.rb
+- lib/portatext/command/api/email_verify.rb
+- lib/portatext/command/api/jobs.rb
 - lib/portatext/command/api/me.rb
+- lib/portatext/command/api/recharge.rb
 - lib/portatext/command/api/settings.rb
+- lib/portatext/command/api/sms.rb
+- lib/portatext/command/api/sms_campaign.rb
 - lib/portatext/command/api/tariffs.rb
+- lib/portatext/command/api/templates.rb
+- lib/portatext/command/api/timezones.rb
 - lib/portatext/command/base.rb
 - lib/portatext/command/descriptor.rb
 - lib/portatext/command/result.rb
@@ -174,9 +187,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.8