textmagic-ruby 2.0.0

data/lib/textmagic-ruby.rb

@@ -0,0 +1,31 @@
+require 'uri'
+require 'cgi'
+require 'net/http'
+require 'net/https'
+require 'multi_json'
+require 'openssl'
+require 'yaml'
+
+require 'textmagic-ruby/rest/utils'
+require 'textmagic-ruby/rest/list_resource'
+require 'textmagic-ruby/rest/instance_resource'
+require 'textmagic-ruby/rest/paginate_resource'
+require 'textmagic-ruby/rest/messages'
+require "textmagic-ruby/rest/version"
+require 'textmagic-ruby/rest/client'
+require 'textmagic-ruby/rest/errors'
+require 'textmagic-ruby/rest/contacts'
+require 'textmagic-ruby/rest/lists'
+require 'textmagic-ruby/rest/custom_fields'
+require 'textmagic-ruby/rest/unsubscribers'
+require 'textmagic-ruby/rest/bulks'
+require 'textmagic-ruby/rest/chats'
+require 'textmagic-ruby/rest/scheduleds'
+require 'textmagic-ruby/rest/sessions'
+require 'textmagic-ruby/rest/templates'
+require 'textmagic-ruby/rest/invoices'
+require 'textmagic-ruby/rest/users'
+require 'textmagic-ruby/rest/numbers'
+require 'textmagic-ruby/rest/senderids'
+require 'textmagic-ruby/rest/subaccounts'
+require 'textmagic-ruby/rest/replies'

data/lib/textmagic-ruby/rest/bulks.rb

@@ -0,0 +1,89 @@
+module Textmagic
+  module REST
+    class Bulks < ListResource
+      ##
+      # Get bulks session by ID.
+      #
+      # uid:: Bulk session ID. Required.
+      #
+      # Example:
+      #
+      #   @bulks = client.bulks.get 111
+      #
+      def get(uid)
+        super
+      end
+      ##
+      # Get all bulk sending sessions.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::  Fetch specified results page. Defaults 1
+      #
+      # limit:: How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @bulks = client.bulks.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+      ##
+      # Creating is not supported.
+      #
+      def create(params={})
+        raise '`create` method is not supported for this resource.'
+      end
+
+      ##
+      # Updating is not supported.
+      #
+      def update(uid, params={})
+        raise '`update` method is not supported for this resource.'
+      end
+
+      ##
+      # Deleting is not supported.
+      #
+      def delete(uid)
+        raise '`delete` method is not supported for this resource.'
+      end
+    end
+
+    ##
+    # A Bulk message session resource.
+    #
+    # ==== @id
+    #
+    # ==== @status
+    #
+    # ==== @items_processed
+    #
+    # ==== @items_total
+    #
+    # ==== @created_at
+    #
+    # ==== @text
+    #
+    # ==== @session
+    #
+    # Hash like this
+    #   {
+    #       "id"           => "34435949",
+    #       "startTime"    => "2015-05-01T21:30:00+0000",
+    #       "text"         => "error",
+    #       "source"       => "O",
+    #       "referenceId"  => "O_xxx_cb5e100e5a9a3e7f6d1fd97512215282_10580074905542fc46b9f157.39758261",
+    #       "price"        =>  0.03,
+    #       "numbersCount" => 1
+    #    }
+    #
+    class Bulk < InstanceResource
+    end
+  end
+end

data/lib/textmagic-ruby/rest/chats.rb

@@ -0,0 +1,147 @@
+module Textmagic
+  module REST
+    class Chats < ListResource
+      ##
+      # Get all user chats.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::  Fetch specified results page. Defaults 1
+      #
+      # limit:: How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @chats = client.chats.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+      ##
+      # Fetch messages from chat with specified phone number.
+      #
+      # phone:: Phone number in E.164 format. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::  Fetch specified results page. Defaults 1
+      #
+      # limit:: How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @chat_messages = client.chats.get_by_phone 99990000
+      #
+      def get_by_phone(phone, params={})
+        response = @client.get "#{@path}/#{phone}", params
+        PaginateResource.new "#{@path}", @client, response, Textmagic::REST::ChatMessage
+      end
+
+      ##
+      # Creating is not supported.
+      #
+      def create(params={})
+        raise '`create` method is not supported for this resource.'
+      end
+
+      ##
+      # Getting by ID is not supported. Try get_by_phone instead.
+      #
+      def get(uid)
+        raise '`get` method by ID is not supported for this resource, use `get_by_phone`.'
+      end
+
+      ##
+      # Updating is not supported.
+      #
+      def update(uid, params={})
+        raise '`update` method is not supported for this resource.'
+      end
+
+      ##
+      # Deleting is not supported.
+      #
+      def delete(uid)
+        raise '`delete` method is not supported for this resource.'
+      end
+    end
+
+    ##
+    # A Chat resource.
+    #
+    # ==== @id
+    #
+    # ==== @phone
+    #
+    # ==== @contact
+    #
+    # Hash like this
+    #   {
+    #       "id": 4329702,
+    #       "first_name": "Jonh",
+    #       "last_name": "Doe",
+    #       "company_name": "",
+    #       "phone": "19025555555",
+    #       "email": "",
+    #       "country": {
+    #         "id": "CA",
+    #         "name": "Canada"
+    #       },
+    #       "custom_fields": [
+    #         {
+    #             "value": "1970-01-01",
+    #             "id": 1111,
+    #             "name": "Birthday",
+    #             "createdAt": "2015-04-10T06:51:02+0000"
+    #         }
+    #       ]
+    #   }
+    #
+    # ==== @unread
+    #
+    # ==== @updated_at
+    #
+    class Chat < InstanceResource
+      def refresh
+        raise '`refresh` method is not supported for this resource.'
+      end
+    end
+
+    ##
+    # A Chat Message resource.
+    #
+    # ==== @id
+    #
+    # ==== @direction
+    #
+    # ==== @sender
+    #
+    # ==== @message_time
+    #
+    # ==== @text
+    #
+    # ==== @receiver
+    #
+    # ==== @deleted
+    #
+    # ==== @user_id
+    #
+    # ==== @status
+    #
+    # ==== @total
+    #
+    # ==== @first_name
+    #
+    # ==== @last_name
+    #
+    class ChatMessage < InstanceResource
+      def refresh
+        raise '`refresh` method is not supported for this resource.'
+      end
+    end
+  end
+end

data/lib/textmagic-ruby/rest/client.rb

@@ -0,0 +1,128 @@
+module Textmagic
+  module REST
+    class Client
+      include Textmagic::REST::Utils
+
+      attr_reader :username, :token, :host
+
+      ##
+      # Create a new TextMagic APIv2 REST HTTP client.
+      #
+      # Example:
+      #
+      #   @client = Textmagic::REST::Client.new username, token
+      #
+      # === <tt>username: 'my_textmagic_username'</tt>
+      #
+      # TextMagic account's username. Can be found here:
+      # https://my.textmagic.com/online/account/details
+      #
+      # === <tt>token: 'my_textmagic_apiv2_token'</tt>
+      #
+      # TextMagic account's token. Can be found here:
+      # https://my.textmagic.com/online/api/rest-api/keys
+      #
+      # === <tt>host: 'https://api.textmagictesting.com'</tt>
+      #
+      # The domain to which you'd like the client to make HTTP requests. Useful
+      # for testing. Defaults to 'https://rest.textmagic.com'.
+      def initialize(username=nil, token=nil, host='https://rest.textmagic.com/api/v2')
+        @username = username
+        @token = token
+        @host = host
+        if @username.nil? || @token.nil?
+          raise ArgumentError, 'Username and token are required'
+        end
+
+        setup_connection
+        setup_resources
+      end
+
+      def inspect # :nodoc:
+        "<#{self.class} @username=#{@username}>"
+      end
+
+      HTTP_HEADERS = {
+          'Accept' => 'application/json',
+          'Accept-Charset' => 'utf-8',
+          'Accept-Language' => 'en-us',
+          'User-Agent' => "textmagic-ruby.#{Textmagic::REST::VERSION}"
+      }
+
+      [:get, :post, :delete, :put].each do |method|
+        method_class = Net::HTTP.const_get method.to_s.capitalize
+        define_method method do |path, *args|
+          params = args[0]
+          params = {} if params.empty?
+          path = build_full_path(path, params, method) unless args[1]
+          HTTP_HEADERS["X-TM-Username"] = @username
+          HTTP_HEADERS["X-TM-Key"] = @token
+          request = method_class.new(path, HTTP_HEADERS)
+          if [:post, :put].include?(method) or
+              ([:delete].include?(method) and !params.empty?)
+            request.set_form_data(to_camel_case(params, false))
+            HTTP_HEADERS['Content-Type'] = 'application/x-www-form-urlencoded'
+          end
+          make_request(request)
+        end
+      end
+
+      def ping
+        path = 'ping'
+        response = self.get "/#{path}", {}
+        response[path]
+      end
+
+      protected
+
+      def url_encode(hash)
+        hash.to_a.map {|p| p.map {|e| CGI.escape e.to_s}.join '='}.join '&'
+      end
+
+      def build_full_path(path, params, method)
+        path << "?#{url_encode(to_camel_case(params, false))}" if method == :get && !params.empty?
+        "#{@host}#{path}"
+      end
+
+      def setup_connection
+        uri = URI.parse(@host)
+        @conn = Net::HTTP.new(uri.host, uri.port)
+        setup_ssl
+      end
+
+      def setup_ssl
+        @conn.use_ssl = true
+        @conn.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        @conn.ca_file = File.dirname(__FILE__) + '/../../../conf/cacert.pem'
+      end
+
+      def make_request(request)
+
+        response = @conn.request request
+
+        if response.kind_of? Net::HTTPServerError
+          raise Textmagic::REST::ServerError
+        end
+
+        if response.body and !response.body.empty?
+          object = MultiJson.load response.body
+        elsif response.code == 204.to_s
+          object = true
+        elsif response.kind_of? Net::HTTPBadRequest
+          object = {:message => 'Bad request', :code => 400}
+        end
+
+        if response.kind_of? Net::HTTPClientError
+          raise Textmagic::REST::RequestError.new object['message'], object['code']
+        end
+        object
+      end
+
+      def setup_resources
+        resource self, :messages, :contacts, :lists, :custom_fields, :unsubscribers,
+                 :bulks, :chats, :schedules, :sessions, :templates, :invoices, :users,
+                 :numbers, :senderids, :subaccounts, :replies
+      end
+    end
+  end
+end

data/lib/textmagic-ruby/rest/contacts.rb

@@ -0,0 +1,174 @@
+module Textmagic
+  module REST
+    class Contacts < ListResource
+      ##
+      # Get contact by ID.
+      # Returns Contact object.
+      #
+      # uid:: Contact ID. Required.
+      #
+      # Example:
+      #
+      #   @contact = client.contacts.get 987
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Create new Contact.
+      # Returns Contact object contains id and link to new Contact.
+      #
+      # The following *params* keys are supported:
+      #
+      # first_name::
+      #
+      # last_name::
+      #
+      # phone::         Contact's phone number. Required.
+      #
+      # email::
+      #
+      # company_name::
+      #
+      # country::       2-letter ISO country code.
+      #
+      # lists::         String of Lists separated by commas to assign contact. Required.
+      #
+      # Example:
+      #
+      #   @contact = client.contacts.create {:phone => '9999999', :lists => '123, 456'}
+      #
+      def create(params={})
+        super params
+      end
+
+      ##
+      # Get all user contacts.
+      # Returns PaginateResource object, contains array of Contact objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # search::  If *true* then search contacts using `query`, `ids` and/or `group_id`. Defaults *false*.
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # shared::  Should contacts in shared lists to be included. Defaults 0
+      #
+      # ids::     Find contact by ID(s). Using with `search`=*true*.
+      #
+      # list_id:: Find contact by List ID. Using with `search`=*true*.
+      #
+      # query::   Find contact by specified search query. Using with `search`=*true*..
+      #
+      # Example:
+      #
+      #   @contacts = client.contacts.list
+      #
+      def list(params={})
+        super params
+      end
+
+      ##
+      # Updates the existing Contact for the given unique id.
+      # Returns Contact object contains id and link to updated Contact.
+      #
+      # uid:: Contact ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # first_name::
+      #
+      # last_name::
+      #
+      # phone::         Contact's phone number. Required.
+      #
+      # email::
+      #
+      # company_name::
+      #
+      # country::       2-letter ISO country code.
+      #
+      # lists::         String of Lists separated by commas to assign contact. Required.
+      #
+      # Example:
+      #
+      #   @contact = client.contacts.update 123, {:phone => '9999999', :lists => '123, 456'}
+      #
+      def update(uid, params={})
+        super uid, params
+      end
+
+      ##
+      # Delete contact by ID. Returns *true* if success.
+      #
+      # uid:: Contact ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.contacts.delete 987
+      #
+      def delete(uid)
+        super uid
+      end
+
+      ##
+      # Fetch lists which contact belongs to.
+      # Returns PaginateResource object, contains array of List objects.
+      #
+      # uid:: Contact ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::  Fetch specified results page. Defaults 1
+      #
+      # limit:: How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @contact = client.contacts.lists 123
+      #
+      def lists(uid, params={})
+        response = @client.get "#{@path}/#{uid}/lists", params
+        PaginateResource.new "#{@path}", @client, response, Textmagic::REST::List
+      end
+    end
+
+    ##
+    # A Contact resource.
+    #
+    # ==== @id
+    #
+    # ==== @phone
+    #
+    # ==== @email
+    #
+    # ==== @first_name
+    #
+    # ==== @last_name
+    #
+    # ==== @company_name
+    #
+    # ==== @country
+    #
+    # Hash like this
+    #   {
+    #       "id"   => "US",
+    #       "name" => "United States",
+    #   }
+    #
+    # ==== @custom_fields
+    #
+    # Array of Hashes, each looks like this
+    #   {
+    #       "value"     => "30",
+    #       "id"        => "1044",
+    #       "name"      => "Age",
+    #       "createdAt" => "2015-04-27T09:29:46+0000",
+    #   }
+    #
+    class Contact < InstanceResource; end
+  end
+end