textmagic-ruby 2.0.0

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

@@ -0,0 +1,172 @@
+module Textmagic
+  module REST
+    class Messages < ListResource
+      ##
+      # Get message by ID.
+      # Returns Message object.
+      #
+      # uid:: Message ID. Required.
+      #
+      # Example:
+      #
+      #   @message = client.messages.get 987
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Send a new outbound Message or create Scheduled message when provide *sending_time* parameters
+      # Returns Message object contains next attributes: 'id', 'href', 'type',
+      # 'sessionId', 'bulkId', 'message_id', 'scheduled_id'.
+      #
+      # The following *params* keys are supported:
+      #
+      # text::         Message text. Required if template_id is not set.
+      #
+      # template_id::  Template used instead of message text. Required if text is not set.
+      #
+      # sending_time:: Message sending time in unix timestamp format. Default is now.
+      #                Optional (required with recurrency_rule set).
+      # contacts::     Contacts ids, separated by comma, message will be sent to.
+      #
+      # lists::        Lists ids, separated by comma, message will be sent to.
+      #
+      # phones::       Phone numbers, separated by comma, message will be sent to.
+      #
+      # cut_extra::    Should sending method cut extra characters
+      #                which not fit supplied parts_count or return 400 Bad request response instead.
+      #                Default is false.
+      # parts_count::  Maximum message parts count (TextMagic allows sending 1 to 6 message parts).
+      #                Default is 6.
+      # reference_id:: Custom message reference id which can be used in your application infrastructure.
+      #
+      # from::         One of allowed Sender ID (phone number or alphanumeric sender ID).
+      #
+      # rrule::        iCal RRULE parameter to create recurrent scheduled messages.
+      #                When used, sending_time is mandatory as start point of sending.
+      # dummy::        If 1, just return message pricing. Message will not send.
+      #
+      # Example:
+      #
+      #   @message = client.messages.create {:text => 'Hello from Ruby', :phones => '99900000, 99999999'}
+      #
+      def create(params={})
+        super params
+      end
+
+      ##
+      # Get all user messages.
+      # Returns PaginateResource object, contains array of Message objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # search::  If *true* then search messages using `query`, `ids` and/or `session_id`. Defaults *false*.
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # ids::     Find message by ID(s). Using with `search`=*true*.
+      #
+      # session_id:: Find message by Session ID. Using with `search`=*true*.
+      #
+      # query::   Find message by specified search query. Using with `search`=*true*..
+      #
+      # Example:
+      #
+      #   @messages = client.messages.list
+      #
+      def list(params={})
+        super params
+      end
+
+      ##
+      # Check pricing for a new outbound message.
+      # An useful synonym for "message" command with "dummy" parameters set to *true*.
+      #
+      # The following *params* keys are supported:
+      #
+      # text::         Message text. Required if template_id is not set.
+      #
+      # template_id::  Template used instead of message text. Required if text is not set.
+      #
+      # sending_time:: Message sending time in unix timestamp format. Default is now.
+      #                Optional (required with recurrency_rule set).
+      # contacts::     Contacts ids, separated by comma, message will be sent to.
+      #
+      # lists::        Lists ids, separated by comma, message will be sent to.
+      #
+      # phones::       Phone numbers, separated by comma, message will be sent to.
+      #
+      # cut_extra::    Should sending method cut extra characters
+      #                which not fit supplied parts_count or return 400 Bad request response instead.
+      #                Default is false.
+      # parts_count::  Maximum message parts count (TextMagic allows sending 1 to 6 message parts).
+      #                Default is 6.
+      # reference_id:: Custom message reference id which can be used in your application infrastructure.
+      #
+      # from::         One of allowed Sender ID (phone number or alphanumeric sender ID).
+      #
+      # rrule::        iCal RRULE parameter to create recurrent scheduled messages.
+      #                When used, sending_time is mandatory as start point of sending.
+      # Example:
+      #
+      #   @message = client.messages.create {:text => 'Hello from Ruby', :phones => '99900000, 99999999'}
+      #
+      def price(params={})
+        response = @client.get "#{@path}/price", params
+        @instance_class.new "#{@path}", @client, response
+      end
+
+      ##
+      # Delete message by ID. Returns *true* if success.
+      #
+      # uid:: Message ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.messages.delete 1110
+      #
+      def delete(uid)
+        super uid
+      end
+      ##
+      # Updating is not supported.
+      # 
+      def update(uid, params={})
+        raise '`update` method is not supported for this resource.'
+      end
+    end
+
+    ##
+    # A Message resource.
+    #
+    # ==== @id
+    #
+    # ==== @receiver
+    #
+    # ==== @message_time
+    #
+    # ==== @status
+    #
+    # ==== @text
+    #
+    # ==== @charset
+    #
+    # ==== @first_name
+    #
+    # ==== @last_name
+    #
+    # ==== @country
+    #
+    # ==== @sender
+    #
+    # ==== @price
+    #
+    # ==== @parts_count
+    #
+    class Message < InstanceResource; end
+  end
+end
+

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

@@ -0,0 +1,164 @@
+module Textmagic
+  module REST
+    class Numbers < ListResource
+      ##
+      # Get number by ID.
+      # Returns Number object.
+      #
+      # uid:: Number ID. Required.
+      #
+      # Example:
+      #
+      #   @number = client.numbers.get 1123
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Get all user dedicated numbers.
+      # Returns PaginateResource object, contains array of Numbers objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @numbers = client.numbers.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+      ##
+      # Find available dedicated numbers to buy.
+      # Returns AvailableNumber object, contains array of available numbers and price.
+      #
+      # The following *params* keys are supported:
+      #
+      # country:: Dedicated number country. Required.
+      #
+      # prefix::  Desired number prefix. Should include country code (i.e. 447 for GB).
+      #
+      # Example:
+      #
+      #   @numbers = client.numbers.available {:country => 'US'}
+      #
+      def available(params={})
+        response = @client.get "#{@path}/available", params
+        AvailableNumber.new "#{@path}", @client, response
+      end
+
+      ##
+      # Buy a dedicated number and assign it to the specified account.
+      # Returns Number object, contains id and link to a new dedicated Number.
+      #
+      # The following *params* keys are supported:
+      #
+      # phone::    Desired dedicated phone number in international E.164 format. Required.
+      #
+      # country::  Dedicated number country. Required.
+      #
+      # user_id::  User ID this number will be assigned to. Required.
+      #
+      # Example:
+      #
+      #   @number = client.numbers.buy {:phone => '19025555555', :country => 'US', :user_id => 1234}
+      #
+      def buy(params={})
+        self.create params
+      end
+
+      ##
+      # Updating is not supported
+      #
+      def update(uid, params={})
+        raise '`update` method is not supported for this resource.'
+      end
+
+      ##
+      # Cancel dedicated number subscription. Returns *true* if success.
+      #
+      # uid:: Number ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.numbers.delete 1290
+      #
+      def delete(uid)
+        super uid
+      end
+    end
+
+    ##
+    # A Number resource.
+    #
+    # ==== @id
+    #
+    # ==== @purchased_at
+    #
+    # ==== @expire_at
+    #
+    # ==== @phone
+    #
+    # ==== @status
+    #
+    # ==== @country
+    #
+    # Hash like this
+    #   {
+    #       "id"   => "US",
+    #       "name" => "United States",
+    #   }
+    #
+    # ==== @user
+    #
+    # Hash like this
+    #   {
+    #     "id": 11111,
+    #     "username": "johndoe",
+    #     "firstName": "John",
+    #     "lastName": "Doe",
+    #     "status": "A",
+    #     "balance": 13.793,
+    #     "company": "TextMagic",
+    #     "currency": {
+    #     "id": "GBP",
+    #     "htmlSymbol": "&pound;"
+    #   },
+    #     "timezone": {
+    #     "id": 2,
+    #     "area": "Pacific",
+    #     "dst": 0,
+    #     "offset": -39600,
+    #     "timezone": "Pacific/Midway"
+    #   },
+    #     "subaccountType": "P"
+    #   }
+    #
+    class Number < InstanceResource
+      def refresh
+        raise '`refresh` method is not supported for this resource.'
+      end
+    end
+
+    ##
+    # An AvailableNumber resource.
+    #
+    # ==== @numbers
+    #
+    # ==== @price
+    #
+    class AvailableNumber < InstanceResource
+      def refresh
+        raise '`refresh` method is not supported for this resource.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+module Textmagic
+  module REST
+    class PaginateResource
+      include Utils
+
+      attr_reader :resources, :page, :page_count, :limit
+      def initialize(path, client, params={}, resource_class=nil)
+        @path = path
+        @client = client
+        %w(page limit pageCount).each do |attr|
+          self.instance_variable_set("@#{to_underscore_case(attr)}", params.fetch(attr))
+        end
+        @resources = Array.new
+        params['resources'].each do |r|
+          @resources << resource_class.new(@path, @client, r)
+        end if resource_class
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+module Textmagic
+  module REST
+    class Replies < ListResource
+      ##
+      # Get reply by ID.
+      # Returns Reply object.
+      #
+      # uid:: Reply ID. Required.
+      #
+      # Example:
+      #
+      #   @reply = client.replies.get 19011
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Get all user replies.
+      # Returns PaginateResource object, contains array of Reply objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # search::  If *true* then search replies using `ids` and/or `query`. Defaults *false*.
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # ids::     Find replies by ID(s). Using with `search`=*true*.
+      #
+      # query::   Find replies by specified search query. Using with `search`=*true*..
+      #
+      # Example:
+      #
+      #   @replies = client.replies.list
+      #
+      def list(params={})
+        super params
+      end
+
+      ##
+      # Delete reply by ID. Returns *true* if success.
+      #
+      # uid:: Reply ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.replies.delete 28919
+      #
+      def delete(uid)
+        super uid
+      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
+    end
+
+    ##
+    # A Reply resource.
+    #
+    # ==== @id
+    #
+    # ==== @sender
+    #
+    # ==== @message_time
+    #
+    # ==== @text
+    #
+    # ==== @receiver
+    #
+    class Reply < InstanceResource; end
+  end
+end

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

@@ -0,0 +1,91 @@
+module Textmagic
+  module REST
+    class Schedules < ListResource
+      ##
+      # Get Schedule by ID.
+      # Returns Schedule object.
+      #
+      # uid:: Schedule ID. Required.
+      #
+      # Example:
+      #
+      #   @scheduled = client.schedules.get 19011
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Get all user scheduled messages.
+      # Returns PaginateResource object, contains array of Schedule objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @schedules = client.schedules.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+      ##
+      # Updating is not supported
+      #
+      def update(uid, params={})
+        raise '`update` method is not supported for this resource.'
+      end
+
+      ##
+      # Delete scheduled message by ID. Returns *true* if success.
+      #
+      # uid:: Schedule message ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.schedules.delete 182981
+      #
+      def delete(uid)
+        super uid
+      end
+
+      ##
+      # Creating is not supported
+      #
+      def create(params={})
+        raise '`create` method is not supported for this resource.'
+      end
+    end
+
+    ##
+    # A Schedule resource.
+    #
+    # ==== @id
+    #
+    # ==== @next_send
+    #
+    # ==== @rrule
+    #
+    # ==== @session
+    #
+    # Hash like this:
+    #   {
+    #     "id": "34435949",
+    #     "startTime": "2015-05-01T21:30:00+0000",
+    #     "text": "Happy Birthday, dude!",
+    #     "source": "O",
+    #     "referenceId": "O_xxx_cb5e100e5a9a3e7f6d1fd97512215282_10580074905542fc46b9f157.39758261",
+    #     "price": 0.03,
+    #     "numbersCount": 1
+    #   }
+    #
+    class Schedule < InstanceResource; end
+  end
+end