textmagic-ruby 2.0.0

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

@@ -0,0 +1,120 @@
+module Textmagic
+  module REST
+    class CustomFields < ListResource
+
+      ##
+      # Get CustomField by ID.
+      # Returns CustomField object.
+      #
+      # uid:: Custom Field ID. Required.
+      #
+      # Example:
+      #
+      #   @custom_field = client.custom_fields.get 987
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Create new CustomField.
+      # Returns CustomField object contains id and link to new CustomField.
+      #
+      # The following *params* keys are supported:
+      #
+      # name::  Name of custom field. Required.
+      #
+      # Example:
+      #
+      #   @custom_field = client.custom_fields.create {:name => 'Birthday'}
+      #
+      def create(params={})
+        super params
+      end
+
+      ##
+      # Get all user custom fields.
+      # Returns PaginateResource object, contains array of CustomField objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @custom_fields = client.custom_fields.list
+      #
+      def list(params={})
+        [:search, 'search'].each do |search|
+          params.delete search
+        end
+        super params
+      end
+
+      ##
+      # Updates the existing CustomField for the given unique id.
+      # Returns CustomField object contains id and link to updated CustomField.
+      #
+      # uid:: Custom field ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # name:: Name of custom field. Required.
+      #
+      # Example:
+      #
+      #   @custom_field = client.custom_fields.update 123, {:name => 'Updated'}
+      #
+      def update(uid, params={})
+        super uid, params
+      end
+
+      ##
+      # Delete CustomField by ID. Returns *true* if success.
+      #
+      # uid:: CustomField ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.custom_fields.delete 987
+      #
+      def delete(uid)
+        super uid
+      end
+
+      ##
+      # Updates contact's custom field value.
+      # Returns Contact object contains id and link to updated Contact.
+      #
+      # uid:: Custom field ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # contact_id:: The unique id of the Contact to update value. Required.
+      #
+      # value::      Value of CustomField. Required.
+      #
+      # Example:
+      #
+      #   @custom_field = client.custom_fields.update 123, {:name => 'Updated'}
+      #
+      def update_value(uid, params={})
+        response = @client.put("#{@path}/#{uid}/update", params)
+        Textmagic::REST::Contact.new @client, @path, response
+      end
+    end
+
+    ##
+    # A Custom Field resource.
+    #
+    # ==== @id
+    #
+    # ==== @name
+    #
+    # ==== @created_at
+    #
+    class CustomField < InstanceResource; end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Textmagic
+  module REST
+    class ServerError < StandardError; end
+
+    class RequestError < StandardError
+      attr_reader :code
+
+      def initialize(message, code=nil);
+      super message
+      @code = code
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Textmagic
+  module REST
+    class InstanceResource
+      include Utils
+
+      def initialize(path, client, params={})
+        @path = path
+        @client = client
+        load_attributes params
+      end
+
+      def inspect # :nodoc:
+        "<#{self.class} @path=#{@path}>"
+      end
+
+      def load_attributes(hash)
+        metaclass = class << self; self; end
+        hash.each do |k,v|
+          attr = to_underscore_case k
+          unless ['client', 'updated'].include? attr
+            metaclass.send :define_method, attr.to_sym, &lambda {v}
+          end
+        end
+        @updated = !hash.keys.empty?
+      end
+
+      def refresh
+        load_attributes(@client.get("#{@path}/#{self.id}", {}))
+        self
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module Textmagic
+  module REST
+    class Invoices < ListResource
+      ##
+      # Get all user invoices.
+      # Returns PaginateResource object, contains array of Invoices objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @invoices = client.invoices.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
+
+      ##
+      # Getting is not supported.
+      #
+      def get(uid)
+        raise '`get` method by ID 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
+
+    ##
+    # An Invoice resource.
+    #
+    # ==== @id
+    #
+    # ==== @bundle
+    #
+    # ==== @currency
+    #
+    # ==== @vat
+    #
+    # ==== @payment_method
+    #
+    class Invoice < InstanceResource
+      def refresh
+        raise '`refresh` method is not supported for this resource.'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+module Textmagic
+  module REST
+    class ListResource
+      include Utils
+
+      def initialize(path, client)
+        custom_names = {
+            'Replies' => 'Reply'
+        }
+        @path, @client = path, client
+        resource_name = self.class.name.split('::')[-1]
+        instance_name = custom_names.fetch(resource_name, resource_name.chop)
+
+        parent_module = self.class.to_s.split('::')[-2]
+        full_module_path = if parent_module == 'REST'
+                             Textmagic::REST
+                           else
+                             Textmagic::REST.const_get parent_module
+                           end
+
+        @instance_class = full_module_path.const_get instance_name
+        @list_key, @instance_id_key = to_underscore_case(resource_name), 'id'
+      end
+
+      def inspect # :nodoc:
+        "<#{self.class} @path=#{@path}>"
+      end
+
+      def list(params={})
+        if params.key?('search') or params.key?(:search)
+          [:search, 'search'].each do |search|
+            params.delete(search)
+          end
+          path = "#{@path}" << '/search'
+        else
+          path = "#{@path}"
+        end
+        response = @client.get path, params
+        PaginateResource.new "#{@path}", @client, response, @instance_class
+      end
+
+      def get(uid, params={})
+        response = @client.get "#{@path}/#{uid}", params
+        @instance_class.new "#{@path}", @client, response
+      end
+
+      def create(params={})
+        response = @client.post "#{@path}", params
+        @instance_class.new "#{@path}", @client, response
+      end
+
+      def update(uid, params={})
+        response = @client.put "#{@path}/#{uid}", params
+        @instance_class.new "#{@path}", @client, response
+      end
+
+      def delete(uid, params={})
+        raise "Can't delete a resource without a REST Client" unless @client
+        response = @client.delete "#{@path}/#{uid}", params
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,166 @@
+module Textmagic
+  module REST
+    class Lists < ListResource
+      ##
+      # Get list by ID.
+      # Returns List object.
+      #
+      # uid:: List ID. Required.
+      #
+      # Example:
+      #
+      #   @list = client.lists.get 987
+      #
+      def get(uid)
+        super uid
+      end
+
+      ##
+      # Create new List.
+      # Returns List object contains id and link to new List.
+      #
+      # The following *params* keys are supported:
+      #
+      # name::    List name. Required.
+      #
+      # shared::  Should this list be shared with sub-accounts. Can be 1 or 0. Defaults 0
+      #
+      # Example:
+      #
+      #   @list = client.lists.create {:name => 'MyList'}
+      #
+      def create(params={})
+        super params
+      end
+
+      ##
+      # Get all user lists.
+      # Returns PaginateResource object, contains array of List objects.
+      #
+      # The following *params* keys are supported:
+      #
+      # search::  If *true* then search lists using `ids` and/or `query`. Defaults *false*.
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # ids::     Find list by ID(s). Using with `search`=*true*.
+      #
+      # query::   Find list by specified search query. Using with `search`=*true*..
+      #
+      # Example:
+      #
+      #   @lists = client.lists.list
+      #
+      def list(params={})
+        super params
+      end
+
+      ##
+      # Updates the existing List for the given unique id.
+      # Returns List object contains id and link to updated List.
+      #
+      # uid:: List ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # name::    List name. Required.
+      #
+      # shared::  Should this list be shared with sub-accounts. Can be 1 or 0. Defaults 0
+      #
+      # Example:
+      #
+      #   @list = client.lists.update 123, {:name => 'Updated List'}
+      #
+      def update(uid, params={})
+        super uid, params
+      end
+
+      ##
+      # Delete list by ID. Returns *true* if success.
+      #
+      # uid:: List ID. Required.
+      #
+      # Example:
+      #
+      #   r = client.lists.delete 987
+      #
+      def delete(uid)
+        super uid
+      end
+
+      ##
+      # Fetch user contacts by given list id.
+      # An useful synonym for "contacts/search" command with provided "list_id" parameter.
+      # Returns PaginateResource object, contains array of Contact objects.
+      #
+      # uid:: List ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # page::    Fetch specified results page. Defaults 1
+      #
+      # limit::   How many results on page. Defaults 10
+      #
+      # Example:
+      #
+      #   @lists = client.lists.contacts 123
+      #
+      def contacts(uid, params={})
+        response = @client.get "#{@path}/#{uid}/contacts", params
+        PaginateResource.new "#{@path}", @client, response, Textmagic::REST::Contact
+      end
+
+      ##
+      # Unassign contacts from the specified list.
+      # Returns *true* if success.
+      #
+      # uid:: List ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # contacts:: Contact ID(s), separated by comma.
+      #
+      # Example:
+      #
+      #   r = client.lists.delete_contacts 123, {:contacts => '122, 1212, 12122'}
+      #
+      def delete_contacts(uid, params={})
+        response = @client.delete "#{@path}/#{uid}/contacts", params
+      end
+
+      ##
+      # Assign contacts to the specified list.
+      # Returns List object contains id and link to updated List.
+      #
+      # uid:: List ID. Required.
+      #
+      # The following *params* keys are supported:
+      #
+      # contacts:: Contact ID(s), separated by comma.
+      #
+      # Example:
+      #
+      #   r = client.lists.put_contacts 123, {:contacts => '122, 1212, 12122'}
+      #
+      def put_contacts(uid, params={})
+        response = @client.put "#{@path}/#{uid}/contacts", params
+        @instance_class.new "#{@path}", @client, response
+      end
+    end
+
+    ##
+    # A List resource.
+    #
+    # ==== @id
+    #
+    # ==== @name
+    #
+    # ==== @members_count
+    #
+    # ==== @shared
+    #
+    class List < InstanceResource; end
+  end
+end