textmagic-ruby 2.0.0

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

@@ -0,0 +1,85 @@
+module Textmagic
+  module REST
+    class Unsubscribers < ListResource
+      ##
+      # Get unsubscriber by ID.
+      # Returns Unsubscriber object.
+      #
+      # uid:: Unsubscriber ID. Required.
+      #
+      # Example:
+      #
+      #   @unsubscriber = client.unsubscribers.get 987
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Unsubscribe phone from your communication by phone number.
+      # Returns Unsubscriber object contains id and link to new Unsubscriber.
+      #
+      # The following *params* keys are supported:
+      #
+      # phone:: Phone number you want to unsubscribe. Required.
+      #
+      # Example:
+      #
+      #   @unsubscriber = client.unsubscribers.create {:phone => '999920102'}
+      #
+      def create(params={})
+        super params
+      end
+
+      ##
+      # Get all user unsubscribers.
+      # Returns PaginateResource object, contains array of Unsubscriber objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @unsubscribers = client.unsubscribers.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+      ##
+      # Deleting is not supported.
+      #
+      def delete(uid)
+        raise '`delete` method is not available for this type of resource.'
+      end
+
+      ##
+      # Updating is not supported.
+      #
+      def update(uid, params={})
+        raise '`update` method is not available for this type of resource.'
+      end
+    end
+
+    ##
+    # A Unsubscriber resource.
+    #
+    # ==== @id
+    #
+    # ==== @phone
+    #
+    # ==== @first_name
+    #
+    # ==== @last_name
+    #
+    # ==== @unsubscribe_time
+    #
+    class Unsubscriber < InstanceResource; end
+  end
+end

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

@@ -0,0 +1,202 @@
+module Textmagic
+  module REST
+    class Users < ListResource
+      def initialize(path, client)
+        super path[0..-2], client
+      end
+
+      def get
+        response = @client.get "#{@path}", {}
+        @instance_class.new "#{@path}", @client, response
+      end
+
+      ##
+      # Get all available sender settings which could be used in "from" parameter of POST messages method.
+      # Returns Source object, contains arrays of allowed sender ids, shared and dedicated numbers.
+      #
+      # The following *params* keys are supported:
+      #
+      # country:: Return sender settings available in specified country only. Optional.
+      #
+      # Example:
+      #
+      #   @allowed = client.users.sources
+      #
+      def sources(params={})
+        path = '/sources'
+        response = @client.get path, params
+        Source.new path, @client, response
+      end
+
+      ##
+      # Return messaging statistics.
+      # Returns an array of hashes each contains messaging stats by given period.
+      #
+      # The following *params* keys are supported:
+      #
+      # by::     Group results by specified period: `off`, `day`, `month` or `year`. Default is `off`.
+      #
+      # start::  Start date in unix timestamp format. Default is 7 days ago.
+      #
+      # end::    End date in unix timestamp format. Default is now.
+      #
+      # Example:
+      #
+      #   @msg_stat = client.users.messaging_stat
+      #
+      def messaging_stat(params={})
+        path = '/stats/messaging'
+        response = @client.get path, params
+      end
+
+      ##
+      # Return account spending statistics.
+      # Returns a PaginateResource object contains array of SpendingStat objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # start::   Start date in unix timestamp format. Default is 7 days ago.
+      #
+      # end::     End date in unix timestamp format. Default is now.
+      #
+      # Example:
+      #
+      #   @spend_stat = client.users.spending_stat
+      #
+      def spending_stat(params={})
+        path = '/stats/spending'
+        response = @client.get path, params
+        PaginateResource.new path, @client, response, SpendingStat
+      end
+
+      ##
+      # Listing is not supported.
+      #
+      def list(params={})
+        raise '`list` method is not supported for this resource.'
+      end
+
+      ##
+      # Get current user info.
+      # Returns *true* if success.
+      #
+      # The following *params* keys are supported:
+      #
+      # first_name::  User first name. Required.
+      #
+      # last_name::   User last name. Required.
+      #
+      # company::     User company. Required.
+      #
+      # Example:
+      #
+      #   r = client.users.update {:first_name => 'Joye', :last_name => 'Tribbiani', :company => 'TextMagic'}
+      #
+      def update(params={})
+        response = @client.put "#{@path}", params
+        @instance_class.new "#{@path}", @client, response
+      end
+
+      ##
+      # Deleting is not supported.
+      #
+      def delete(uid)
+        raise '`delete` method is not supported for this resource.'
+      end
+
+      ##
+      # Creating is not supporred.
+      #
+      def create(params={})
+        raise '`create` method is not supported for this resource.'
+      end
+    end
+
+    ##
+    # A Subaccount resource.
+    #
+    # ==== @id
+    #
+    # ==== @username
+    #
+    # ==== @first_name
+    #
+    # ==== @last_name
+    #
+    # ==== @balance
+    #
+    # ==== @company
+    #
+    # ==== @currency
+    #
+    # Hash like this:
+    #   {
+    #     "id": "GBP",
+    #     "htmlSymbol": "&pound;"
+    #   }
+    #
+    # ==== @timezone
+    #
+    # Hash like this:
+    #   {
+    #     "area": "Pacific",
+    #     "dst": "0",
+    #     "offset": "-39600",
+    #     "timezone": "Pacific/Midway"
+    #   }
+    #
+    # ==== @subaccount_type
+    #
+    class User < InstanceResource
+      def refresh
+        load_attributes(@client.get("#{@path}", {}))
+        self
+      end
+    end
+
+    ##
+    # A Source resource.
+    #
+    # ==== @dedicated
+    #
+    # ==== @shared
+    #
+    # ==== @sender_ids
+    #
+    class Source < InstanceResource
+      def refresh
+        raise '`refresh` method is not supported for this resource.'
+      end
+    end
+
+    ##
+    # A SpendingStat resource.
+    #
+    # ==== @id
+    #
+    # ==== @user_id
+    #
+    # ==== @date
+    #
+    # ==== @balance
+    #
+    # ==== @delta
+    #
+    # ==== @type
+    #
+    # ==== @value
+    #
+    # ==== @comment
+    #
+    class SpendingStat < InstanceResource
+      def refresh
+        raise '`refresh` method is not supported for this resource.'
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,48 @@
+module Textmagic
+  module REST
+    module Utils
+
+      def to_camel_case(o, capitalize = true)
+        return key_map(o, :to_camel_case, capitalize) if o.is_a? Hash
+        string = o.to_s
+        string = string.split('_').map do |s_part|
+          s_part[0,1].capitalize + s_part[1..-1]
+        end.join
+        unless capitalize
+          return string[0,1].downcase + string[1..-1]
+        else
+          return string
+        end
+      end
+
+      def to_underscore_case(o, capitalize = false)
+        return key_map(o, :to_underscore_case) if o.is_a? Hash
+        string = o.to_s
+        string = string[0,1].downcase + string[1..-1]
+        string.gsub(/[A-Z][a-z]*/) {|s| "_#{s.downcase}"}
+      end
+
+      def resource(client, *resources)
+        resources.each do |r|
+          resource = to_camel_case r
+          path = "#{@path}/#{resource}".downcase
+          enclosing_module = if @submodule == nil
+                               Textmagic::REST
+                             else
+                               Textmagic::REST.const_get(@submodule)
+                             end
+          resource_class = enclosing_module.const_get resource
+          instance_variable_set("@#{r}", resource_class.new(path, client))
+        end
+        self.class.instance_eval { attr_reader *resources }
+      end
+
+      def key_map(s, method, capitalize = true)
+        s = s.to_a.flat_map do |pair|
+          [send(method, pair[0], capitalize).to_sym, pair[1]]
+        end
+        Hash[*s]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Textmagic
+  module REST
+    VERSION = '2.0.0'
+  end
+end

data/spec/rest/client_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Textmagic::REST::Client do
+
+  it 'should set username and token when initialize' do
+    client = Textmagic::REST::Client.new 'johnsmith', 'auth_token'
+    expect(client.username).to eq('johnsmith')
+    expect(client.token).to eq('auth_token')
+  end
+
+  it 'should throw an error if the username and token is not set' do
+    expect{Textmagic::REST::Client.new}.to raise_error(ArgumentError)
+  end
+
+  it 'should throw an error if only username or only token set' do
+    expect{Textmagic::REST::Client.new 'username'}.to raise_error(ArgumentError)
+    expect{Textmagic::REST::Client.new nil, 'token'}.to raise_error(ArgumentError)
+  end
+
+  [:messages, :contacts, :lists, :custom_fields, :unsubscribers,
+   :bulks, :chats, :schedules, :sessions, :templates, :invoices, :users,
+   :numbers, :senderids, :subaccounts, :replies, :post, :get,
+   :put, :delete].each do |method|
+    it "should have method #{method}." do
+      client = Textmagic::REST::Client.new 'username', 'token'
+      expect(client).to respond_to(method)
+    end
+  end
+
+  it 'should not raise an error if response body is empty' do
+    FakeWeb.register_uri(:any, %r/rest\.textmagic\.com/, body: '')
+    client = Textmagic::REST::Client.new 'username', 'token'
+    client.messages.delete 1
+  end
+
+  it 'should change default connection address' do
+    client = Textmagic::REST::Client.new 'username', 'token', 'https://api.something.com'
+    conn = client.instance_variable_get(:@conn)
+    expect(conn.address).to eq('api.something.com')
+  end
+
+  it 'should set up proper default ssl connection' do
+    client = Textmagic::REST::Client.new 'username', 'token'
+    conn = client.instance_variable_get(:@conn)
+    expect(conn.address).to eq('rest.textmagic.com')
+    expect(conn.port).to eq(443)
+    expect(conn.use_ssl?).to eq(true)
+  end
+
+  it 'should have a ping method' do
+    FakeWeb.register_uri(:any, %r/rest\.textmagic\.com/, body: '{"ping": "pong"}')
+    client = Textmagic::REST::Client.new 'username', 'token'
+    expect(client).to respond_to(:ping)
+    expect(client.ping).to eq('pong')
+  end
+
+end

data/spec/rest/contact_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Textmagic::REST::Contact do
+  before do
+    @contact = Textmagic::REST::Contact.new 'mockPath', 'mockClient'
+  end
+
+  it 'sets up a client and path' do
+    expect(@contact.instance_variable_get(:@client)).to eq('mockClient')
+    expect(@contact.instance_variable_get(:@path)).to eq('mockPath')
+  end
+
+  [:refresh].each do |method|
+    it "should have method #{method}" do
+      expect(@contact).to respond_to(method)
+    end
+  end
+
+end
+
+describe Textmagic::REST::Contacts do
+  before do
+    @contacts = Textmagic::REST::Contacts.new 'mockPath', 'mockClient'
+  end
+
+  [:list, :get, :update, :create, :delete, :lists].each do |method|
+    it "should have method #{method}" do
+      expect(@contacts).to respond_to(method)
+    end
+  end
+
+  it 'sets up a client and path' do
+    expect(@contacts.instance_variable_get(:@client)).to eq('mockClient')
+    expect(@contacts.instance_variable_get(:@path)).to eq('mockPath')
+  end
+end

data/spec/rest/custom_fields_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Textmagic::REST::CustomField do
+  before do
+    @custom_field = Textmagic::REST::CustomField.new 'mockPath', 'mockClient'
+  end
+
+  it 'sets up a client and path' do
+    expect(@custom_field.instance_variable_get(:@client)).to eq('mockClient')
+    expect(@custom_field.instance_variable_get(:@path)).to eq('mockPath')
+  end
+
+  [:refresh].each do |method|
+    it "should have method #{method}" do
+      expect(@custom_field).to respond_to(method)
+    end
+  end
+
+end
+
+describe Textmagic::REST::CustomFields do
+  before do
+    @custom_fields = Textmagic::REST::CustomFields.new 'mockPath', 'mockClient'
+  end
+
+  [:list, :get, :update, :create, :delete, :update_value].each do |method|
+    it "should have method #{method}" do
+      expect(@custom_fields).to respond_to(method)
+    end
+  end
+
+  it 'sets up a client and path' do
+    expect(@custom_fields.instance_variable_get(:@client)).to eq('mockClient')
+    expect(@custom_fields.instance_variable_get(:@path)).to eq('mockPath')
+  end
+end