serwersms 0.0.3 → 2.0.0

data/lib/serwersms/resources/messages.rb

@@ -0,0 +1,228 @@
+module SerwerSMS
+  module Resources
+    class Messages
+      def initialize(client)
+        @client = client
+      end
+
+      # Send SMS message
+      #
+      # @param phone  [String]
+      # @param text   [String] Message content
+      # @param sender [String] Sender name — only for FULL SMS
+      # @param params [Hash]
+      #   @option params [Boolean] :details   Show details of messages
+      #   @option params [Boolean] :utf       Change encoding to UTF-8 (only for FULL SMS)
+      #   @option params [Boolean] :flash
+      #   @option params [Boolean] :speed     Priority canal — only for FULL SMS
+      #   @option params [Boolean] :test      Test mode
+      #   @option params [Boolean] :vcard     vCard message
+      #   @option params [String]  :wap_push  WAP Push URL address
+      #   @option params [String]  :date      Set the date of sending
+      #   @option params [Integer] :group_id  Sending to the group instead of a phone number
+      #   @option params [Integer] :contact_id Sending to phone from contacts
+      #   @option params [String]  :unique_id Own identifiers of messages
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :queued  Number of queued messages
+      #   @option return [Integer] :unsent  Number of unsent messages
+      #   @option return [Array]   :items
+      #     @option item [String]  :id
+      #     @option item [String]  :phone
+      #     @option item [String]  :status    queued|unsent
+      #     @option item [String]  :queued    Date of enqueued
+      #     @option item [Integer] :parts     Number of parts
+      #     @option item [Integer] :error_code
+      #     @option item [String]  :error_message
+      #     @option item [String]  :text
+      def send_sms(phone, text, sender = nil, params = {})
+        params['phone']  = phone
+        params['text']   = text
+        params['sender'] = sender
+        @client.call('messages/send_sms', params)
+      end
+
+      # Send personalized messages
+      #
+      # @param messages [Array]
+      #   @option message [String] :phone
+      #   @option message [String] :text
+      # @param sender [String] Sender name — only for FULL SMS
+      # @param params [Hash]
+      #   @option params [Boolean]       :details  Show details of messages
+      #   @option params [Boolean]       :utf      Change encoding to UTF-8 (only for FULL SMS)
+      #   @option params [Boolean]       :flash
+      #   @option params [Boolean]       :speed    Priority canal — only for FULL SMS
+      #   @option params [Boolean]       :test     Test mode
+      #   @option params [String]        :date     Set the date of sending
+      #   @option params [Integer,Array] :group_id Sending to the group instead of a phone number
+      #   @option params [String]        :text     Message if group_id is set
+      #   @option params [String,Array]  :unique_id Own identifiers of messages
+      #   @option params [Boolean]       :voice    Send VMS
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :queued
+      #   @option return [Integer] :unsent
+      #   @option return [Array]   :items
+      def send_personalized(messages, sender = nil, params = {})
+        params['messages'] = messages
+        params['sender']   = sender
+        @client.call('messages/send_personalized', params)
+      end
+
+      # Send Voice message
+      #
+      # @param phone  [String]
+      # @param params [Hash]
+      #   @option params [String]        :text       Text to speech
+      #   @option params [String]        :file_id    ID of wav file
+      #   @option params [String]        :date       Set the date of sending
+      #   @option params [Boolean]       :test       Test mode
+      #   @option params [Integer,Array] :group_id   Sending to the group instead of a phone number
+      #   @option params [Integer,Array] :contact_id Sending to phone from contacts
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :queued
+      #   @option return [Integer] :unsent
+      #   @option return [Array]   :items
+      def send_voice(phone, params = {})
+        params['phone'] = phone
+        @client.call('messages/send_voice', params)
+      end
+
+      # Send MMS
+      #
+      # @param phone  [String, Array]
+      # @param title  [String] Title of message (max 40 chars)
+      # @param params [Hash]
+      #   @option params [String]        :file_id  File ID
+      #   @option params [String,Array]  :file     File in base64 encoding
+      #   @option params [String]        :date     Set the date of sending
+      #   @option params [Boolean]       :test     Test mode
+      #   @option params [Integer,Array] :group_id Sending to the group instead of a phone number
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :queued
+      #   @option return [Integer] :unsent
+      #   @option return [Array]   :items
+      def send_mms(phone, title, params = {})
+        params['phone'] = phone
+        params['title'] = title
+        @client.call('messages/send_mms', params)
+      end
+
+      # Send message to ND/SC number
+      #
+      # @param phone [String] Sender phone number
+      # @param text  [String] Message
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def send_nd(phone, text)
+        @client.call('messages/send_nd', 'phone' => phone, 'text' => text)
+      end
+
+      # Send message to NDI/SCI number
+      #
+      # @param phone      [String] Sender phone number
+      # @param text       [String] Message
+      # @param ndi_number [String] Recipient phone number
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def send_ndi(phone, text, ndi_number)
+        @client.call('messages/send_ndi', 'phone' => phone, 'text' => text, 'ndi_number' => ndi_number)
+      end
+
+      # View single message
+      #
+      # @param id     [String]
+      # @param params [Hash]
+      #   @option params [String]  :unique_id
+      #   @option params [Boolean] :show_contact Show details of the recipient from contacts
+      # @return [Hash]
+      #   @option return [String] :id
+      #   @option return [String] :phone
+      #   @option return [String] :status  delivered|undelivered|sent|unsent|in_progress|saved
+      #   @option return [String] :queued  Date of enqueued
+      #   @option return [String] :sent    Date of sending
+      #   @option return [String] :delivered Date of delivery
+      #   @option return [String] :sender
+      #   @option return [String] :type    eco|full|mms|voice
+      #   @option return [String] :text
+      #   @option return [String] :reason  message_expired|unsupported_number|message_rejected|
+      #                                    missed_call|wrong_number|limit_exhausted|lock_send|
+      #                                    wrong_message|operator_error|wrong_sender_name|
+      #                                    number_is_blacklisted|sending_to_foreign_networks_is_locked|
+      #                                    no_permission_to_send_messages|other_error
+      #   @option return [Hash]   :contact
+      def view(id, params = {})
+        params['id'] = id
+        @client.call('messages/view', params)
+      end
+
+      # Check message delivery reports
+      #
+      # @param params [Hash]
+      #   @option params [String,Array]  :id           Message ID
+      #   @option params [String,Array]  :unique_id    Message unique ID
+      #   @option params [String,Array]  :phone
+      #   @option params [String]        :date_from    Start date
+      #   @option params [String]        :date_to      End date
+      #   @option params [String]        :status       delivered|undelivered|pending|sent|unsent
+      #   @option params [String]        :type         eco|full|mms|voice
+      #   @option params [Integer]       :stat_id      Package ID
+      #   @option params [Boolean]       :show_contact Show details of the recipient from contacts
+      #   @option params [Integer]       :page         The number of the displayed page
+      #   @option params [Integer]       :limit        Limit items displayed on single page
+      #   @option params [String]        :order        asc|desc
+      # @return [Hash]
+      #   @option return [Hash]  :paging
+      #     @option paging [Integer] :page
+      #     @option paging [Integer] :count
+      #   @option return [Array] :items
+      def reports(params = {})
+        @client.call('messages/reports', params)
+      end
+
+      # List of received messages
+      #
+      # @param type   [String] eco|nd|ndi|mms
+      # @param params [Hash]
+      #   @option params [String]  :ndi       Filtering by NDI
+      #   @option params [String]  :phone     Filtering by phone
+      #   @option params [String]  :date_from Start date
+      #   @option params [String]  :date_to   End date
+      #   @option params [Boolean] :read      Mark as read
+      #   @option params [Integer] :page      The number of the displayed page
+      #   @option params [Integer] :limit     Limit items displayed on single page
+      #   @option params [String]  :order     asc|desc
+      # @return [Hash]
+      #   @option return [Hash]  :paging
+      #   @option return [Array] :items
+      #     @option item [Integer] :id
+      #     @option item [String]  :type      eco|nd|ndi|mms
+      #     @option item [String]  :phone
+      #     @option item [String]  :received  Date of received message
+      #     @option item [String]  :message_id ID of outgoing message (only for ECO SMS)
+      #     @option item [Boolean] :blacklist  Is the phone blacklisted?
+      #     @option item [String]  :text       Message
+      #     @option item [String]  :to_number  Number of the recipient (for MMS)
+      #     @option item [String]  :title      Title of message (for MMS)
+      #     @option item [Array]   :attachments (for MMS)
+      #     @option item [Hash]    :contact
+      def received(type, params = {})
+        params['type'] = type
+        @client.call('messages/received', params)
+      end
+
+      # Delete message from the scheduler
+      #
+      # @param id        [String]
+      # @param unique_id [String]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def delete(id, unique_id = nil)
+        @client.call('messages/delete', 'id' => id, 'unique_id' => unique_id)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/phones.rb

@@ -0,0 +1,33 @@
+module SerwerSMS
+  module Resources
+    class Phones
+      def initialize(client)
+        @client = client
+      end
+
+      # Check phone via HLR
+      #
+      # @param phone [String]
+      # @param id    [String] Query ID returned if processing takes longer than 60 seconds
+      # @return [Hash]
+      #   @option return [String]  :phone
+      #   @option return [String]  :status
+      #   @option return [Integer] :imsi
+      #   @option return [String]  :network
+      #   @option return [Boolean] :ported
+      #   @option return [String]  :network_ported
+      def check(phone, id = nil)
+        @client.call('phones/check', 'phone' => phone, 'id' => id)
+      end
+
+      # Validate phone number
+      #
+      # @param phone [String]
+      # @return [Hash]
+      #   @option return [Boolean] :correct
+      def test(phone)
+        @client.call('phones/test', 'phone' => phone)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/premium.rb

@@ -0,0 +1,48 @@
+module SerwerSMS
+  module Resources
+    class Premium
+      def initialize(client)
+        @client = client
+      end
+
+      # List of received SMS Premium
+      #
+      # @return [Hash]
+      #   @option return [Array] :items
+      #     @option item [Integer] :id
+      #     @option item [String]  :to_number   Premium number
+      #     @option item [String]  :from_number Sender phone number
+      #     @option item [String]  :date
+      #     @option item [Integer] :limit       Limitation the number of responses
+      #     @option item [String]  :text        Message
+      def index(params = {})
+        @client.call('premium/index', params)
+      end
+
+      # Send reply for received SMS Premium
+      #
+      # @param phone [String] Recipient phone number
+      # @param text  [String] Message
+      # @param gate  [String] Premium number
+      # @param id    [Integer] ID of received SMS Premium
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def send(phone, text, gate, id)
+        @client.call('premium/send', 'phone' => phone, 'text' => text, 'gate' => gate, 'id' => id)
+      end
+
+      # View quiz results
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      #   @option return [Integer] :id
+      #   @option return [String]  :name
+      #   @option return [Array]   :items
+      #     @option item [Integer] :id
+      #     @option item [Integer] :count Number of responses
+      def quiz(id)
+        @client.call('quiz/view', 'id' => id)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/senders.rb

@@ -0,0 +1,33 @@
+module SerwerSMS
+  module Resources
+    class Senders
+      def initialize(client)
+        @client = client
+      end
+
+      # Create new sender name
+      #
+      # @param name [String]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def add(name)
+        @client.call('senders/add', 'name' => name)
+      end
+
+      # List of senders
+      #
+      # @param params [Hash]
+      #   @option params [Boolean] :predefined
+      #   @option params [String]  :sort  Values: name
+      #   @option params [String]  :order Values: asc|desc
+      # @return [Hash]
+      #   @option return [Array] :items
+      #     @option item [String] :name
+      #     @option item [String] :agreement  delivered|required|not_required
+      #     @option item [String] :status     pending_authorization|authorized|rejected|deactivated
+      def index(params = {})
+        @client.call('senders/index', params)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/stats.rb

@@ -0,0 +1,31 @@
+module SerwerSMS
+  module Resources
+    class Stats
+      def initialize(client)
+        @client = client
+      end
+
+      # Sending statistics
+      #
+      # @param params [Hash]
+      #   @option params [String] :type  eco|full|voice|mms
+      #   @option params [String] :begin Start date
+      #   @option params [String] :end   End date
+      # @return [Hash]
+      #   @option return [Array] :items
+      #     @option item [Integer] :id
+      #     @option item [String]  :name
+      #     @option item [Integer] :delivered
+      #     @option item [Integer] :pending
+      #     @option item [Integer] :undelivered
+      #     @option item [Integer] :unsent
+      #     @option item [String]  :begin
+      #     @option item [String]  :end
+      #     @option item [String]  :text
+      #     @option item [String]  :type  eco|full|voice|mms
+      def index(params = {})
+        @client.call('stats/index', params)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/subaccounts.rb

@@ -0,0 +1,72 @@
+module SerwerSMS
+  module Resources
+    class Subaccounts
+      def initialize(client)
+        @client = client
+      end
+
+      # Create new subaccount
+      #
+      # @param subaccount_username [String]
+      # @param subaccount_password [String]
+      # @param subaccount_id       [Integer] Subaccount ID used as permissions template
+      # @param params              [Hash]
+      #   @option params [String] :name
+      #   @option params [String] :phone
+      #   @option params [String] :email
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def add(subaccount_username, subaccount_password, subaccount_id, params = {})
+        params['subaccount_username'] = subaccount_username
+        params['subaccount_password'] = subaccount_password
+        params['subaccount_id']       = subaccount_id
+        @client.call('subaccounts/add', params)
+      end
+
+      # List of subaccounts
+      #
+      # @return [Hash]
+      #   @option return [Array] :items
+      #     @option item [Integer] :id
+      #     @option item [String]  :username
+      def index(params = {})
+        @client.call('subaccounts/index', params)
+      end
+
+      # View subaccount details
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      #   @option return [Integer] :id
+      #   @option return [String]  :username
+      #   @option return [String]  :name
+      #   @option return [String]  :phone
+      #   @option return [String]  :email
+      def view(id)
+        @client.call('subaccounts/view', 'id' => id)
+      end
+
+      # Set limit on subaccount
+      #
+      # @param id    [Integer]
+      # @param type  [String]  eco|full|voice|mms|hlr
+      # @param value [Integer]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def limit(id, type, value)
+        @client.call('subaccounts/limit', 'id' => id, 'type' => type, 'value' => value)
+      end
+
+      # Delete a subaccount
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def delete(id)
+        @client.call('subaccounts/delete', 'id' => id)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/templates.rb

@@ -0,0 +1,55 @@
+module SerwerSMS
+  module Resources
+    class Templates
+      def initialize(client)
+        @client = client
+      end
+
+      # List of templates
+      #
+      # @param params [Hash]
+      #   @option params [String] :sort  Values: name
+      #   @option params [String] :order Values: asc|desc
+      # @return [Hash]
+      #   @option return [Array] :items
+      #     @option item [Integer] :id
+      #     @option item [String]  :name
+      #     @option item [String]  :text
+      def index(params = {})
+        @client.call('templates/index', params)
+      end
+
+      # Add new template
+      #
+      # @param name [String]
+      # @param text [String]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def add(name, text)
+        @client.call('templates/add', 'name' => name, 'text' => text)
+      end
+
+      # Edit a template
+      #
+      # @param id   [Integer]
+      # @param name [String]
+      # @param text [String]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def edit(id, name, text)
+        @client.call('templates/edit', 'id' => id, 'name' => name, 'text' => text)
+      end
+
+      # Delete a template
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def delete(id)
+        @client.call('templates/delete', 'id' => id)
+      end
+    end
+  end
+end

data/lib/serwersms/resources_mixin.rb

@@ -0,0 +1,55 @@
+module SerwerSMS
+  module ResourcesMixin
+    def messages
+      @messages ||= SerwerSMS::Resources::Messages.new(self)
+    end
+
+    def accounts
+      @accounts ||= SerwerSMS::Resources::Accounts.new(self)
+    end
+
+    def blacklist
+      @blacklist ||= SerwerSMS::Resources::Blacklist.new(self)
+    end
+
+    def contacts
+      @contacts ||= SerwerSMS::Resources::Contacts.new(self)
+    end
+
+    def error
+      @error ||= SerwerSMS::Resources::Error.new(self)
+    end
+
+    def files
+      @files ||= SerwerSMS::Resources::Files.new(self)
+    end
+
+    def groups
+      @groups ||= SerwerSMS::Resources::Groups.new(self)
+    end
+
+    def phones
+      @phones ||= SerwerSMS::Resources::Phones.new(self)
+    end
+
+    def premium
+      @premium ||= SerwerSMS::Resources::Premium.new(self)
+    end
+
+    def senders
+      @senders ||= SerwerSMS::Resources::Senders.new(self)
+    end
+
+    def stats
+      @stats ||= SerwerSMS::Resources::Stats.new(self)
+    end
+
+    def subaccounts
+      @subaccounts ||= SerwerSMS::Resources::Subaccounts.new(self)
+    end
+
+    def templates
+      @templates ||= SerwerSMS::Resources::Templates.new(self)
+    end
+  end
+end

data/lib/serwersms.rb

@@ -1,58 +1,21 @@
-class Serwersms
-
-  @@api_url = 'http://api2.serwersms.pl/'
-  @format   = 'json'
-  @@system   = 'client_ruby'
-  attr :messages, true
-  attr :files, true
-  attr :premium, true
-  attr :accounts, true
-  attr :senders, true
-  attr :groups, true
-  attr :contacts, true
-  attr :phones, true
-  attr :subaccounts, true
-  attr :blacklist, true
-  attr :payments, true
-  attr :stats, true
-  attr :templates, true
-  attr :error, true
-  
-  def initialize(username, password)
-      @username     = username
-      @password     = password
-      @messages     = Messages.new(self)
-      @files        = Files.new(self)
-      @premium      = Premium.new(self)
-      @accounts     = Accounts.new(self)
-      @senders      = Senders.new(self)
-      @groups       = Groups.new(self)
-      @contacts     = Contacts.new(self)
-      @phones       = Phones.new(self)
-      @subaccounts  = Subaccounts.new(self)
-      @blacklist    = Blacklist.new(self)
-      @payments     = Payments.new(self)
-      @stats        = Stats.new(self)
-      @templates    = Templates.new(self)
-      @error        = Error.new(self)
-  end
-  
-  def call(url, params = {})
-      uri = URI.parse(@@api_url+url)
-      https = Net::HTTP.new(uri.host,uri.port)
-      req = Net::HTTP::Post.new(uri.path,{'Content-Type' => 'application/json'})
-      params['username'] = @username
-      params['password'] = @password
-      params['system']   = @@system
-      puts @@system
-      req.body = params.to_json
-      res = https.request(req)
-      
-      return res.body
-  end
-end
-
-require 'net/http'
-require 'net/https'
-require 'json'
-Dir[File.dirname(__FILE__) + '/library/*.rb'].each {|file| require file }
+require 'serwersms/error'
+require 'serwersms/http/api_client'
+require 'serwersms/http/http_credentials'
+require 'serwersms/http/http_token'
+require 'serwersms/resources/accounts'
+require 'serwersms/resources/blacklist'
+require 'serwersms/resources/contacts'
+require 'serwersms/resources/error'
+require 'serwersms/resources/files'
+require 'serwersms/resources/groups'
+require 'serwersms/resources/messages'
+require 'serwersms/resources/phones'
+require 'serwersms/resources/premium'
+require 'serwersms/resources/senders'
+require 'serwersms/resources/stats'
+require 'serwersms/resources/subaccounts'
+require 'serwersms/resources/templates'
+require 'serwersms/resources_mixin'
+require 'serwersms/client_credentials'
+require 'serwersms/client_token'
+require 'serwersms/client_factory'