serwersms 0.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5fae7c24831d58f8016814947f532eb70b4c976
-  data.tar.gz: c3393eb5889ba7d89efc44ff8cfff0bb2c2188b4
+SHA256:
+  metadata.gz: bb814e6525d1dd5912fb68505139c28b7a2236666f9e37e228c09c375d7160fe
+  data.tar.gz: 63307ff009e5d67462229fb226ac0b04e2584e17730039d7ac9d727fa57e0cd6
 SHA512:
-  metadata.gz: 2934124784baad70b8d334524fb29ab40a64d528d6a36d64b95bd15ae3a58165cd5bbfb647026d94a82037da4b7f9fa3b34e7c9d477538e1cfe4b88c7339d5be
-  data.tar.gz: 9bf1c5456cf7871c6d7adf80dc2e461fcc9d3b30bb0e2a5df0213d36d309fc20850b74a3f2a242cf8fecbdc07118bde5bb5f58c1ca1c75cc07aa695b3f206abd
+  metadata.gz: 10a5942f9fd9fd281f1211d7f0e86c350743f344473a25c0906281bfda3f961378b594a641c4bc3476e1665efbc9677d916ee90f861d36f809b11d8e3994bd36
+  data.tar.gz: e9149d162235cb9c06878bd5b368078bec62580d45020e4639d95c6eda02f9cb5e1d5e16042c1f185d602e42756a4090d338684a27bf81d9224d45b0b07692a0

data/lib/serwersms/client_credentials.rb

@@ -0,0 +1,13 @@
+module SerwerSMS
+  class ClientCredentials
+    include SerwerSMS::ResourcesMixin
+
+    def initialize(username:, password:, **opts)
+      @http = Http::HttpCredentials.new(username: username, password: password, **opts)
+    end
+
+    def call(path, params = {})
+      @http.call(path, params)
+    end
+  end
+end

data/lib/serwersms/client_factory.rb

@@ -0,0 +1,76 @@
+require 'yaml'
+
+module SerwerSMS
+  class ClientFactory
+    USERNAME_KEY = 'SERWERSMS_USERNAME'
+    PASSWORD_KEY = 'SERWERSMS_PASSWORD'
+    TOKEN_KEY    = 'SERWERSMS_TOKEN'
+    API_URL_KEY  = 'SERWERSMS_API_URL'
+    TIMEOUT_KEY  = 'SERWERSMS_TIMEOUT'
+
+    # Tworzy klienta na podstawie zmiennych środowiskowych.
+    #
+    # Przykład:
+    #   SerwerSMS::ClientFactory.from_env
+    #
+    def self.from_env
+      opts = {}
+      opts[:api_url] = ENV[API_URL_KEY]      if ENV[API_URL_KEY]
+      opts[:timeout] = ENV[TIMEOUT_KEY].to_i if ENV[TIMEOUT_KEY]
+
+      build_client(
+        token:    ENV[TOKEN_KEY],
+        username: ENV[USERNAME_KEY],
+        password: ENV[PASSWORD_KEY],
+        **opts
+      )
+    end
+
+    # Tworzy klienta na podstawie pliku YAML.
+    #
+    # Przykład pliku config/serwersms.yml:
+    #
+    #   # Opcja 1 - autentykacja przez token (zalecana)
+    #   serwersms_token: 'twoj_token'
+    #
+    #   # Opcja 2 - autentykacja przez login i hasło
+    #   # serwersms_username: 'twoj_login'
+    #   # serwersms_password: 'twoje_haslo'
+    #
+    #   # Opcjonalne
+    #   # serwersms_api_url: 'https://api2.serwersms.pl'
+    #   # serwersms_timeout: 30
+    #
+    # Przykład użycia:
+    #   SerwerSMS::ClientFactory.from_yaml('config/serwersms.yml')
+    #
+    def self.from_yaml(yaml_file)
+      raise SerwerSMS::Error, "Config file not found: #{yaml_file}" unless File.exist?(yaml_file)
+
+      cfg = YAML.safe_load_file(yaml_file) || {}
+
+      opts = {}
+      opts[:api_url] = cfg['serwersms_api_url'] if cfg['serwersms_api_url']
+      opts[:timeout] = cfg['serwersms_timeout'] if cfg['serwersms_timeout']
+
+      build_client(
+        token:    cfg['serwersms_token'],
+        username: cfg['serwersms_username'],
+        password: cfg['serwersms_password'],
+        **opts
+      )
+    end
+
+    private
+
+    def self.build_client(token:, username:, password:, **opts)
+      if !token.to_s.strip.empty?
+        ClientToken.new(token: token, **opts)
+      elsif !username.to_s.strip.empty? && !password.to_s.strip.empty?
+        ClientCredentials.new(username: username, password: password, **opts)
+      else
+        raise SerwerSMS::Error, 'Wymagany SERWERSMS_TOKEN lub para SERWERSMS_USERNAME + SERWERSMS_PASSWORD'
+      end
+    end
+  end
+end

data/lib/serwersms/client_token.rb

@@ -0,0 +1,13 @@
+module SerwerSMS
+  class ClientToken
+    include SerwerSMS::ResourcesMixin
+
+    def initialize(token:, **opts)
+      @http = Http::HttpToken.new(token: token, **opts)
+    end
+
+    def call(path, params = {})
+      @http.call(path, params)
+    end
+  end
+end

data/lib/serwersms/error.rb

@@ -0,0 +1,10 @@
+module SerwerSMS
+  class Error < StandardError
+    attr_reader :code
+
+    def initialize(message = nil, code = 0)
+      super(message)
+      @code = code.to_i
+    end
+  end
+end

data/lib/serwersms/http/api_client.rb

@@ -0,0 +1,63 @@
+require 'net/http'
+require 'json'
+require 'openssl'
+
+module SerwerSMS
+  module Http
+    class ApiClient
+      API_URL = 'https://api2.serwersms.pl'.freeze
+      SYSTEM  = 'client_ruby'.freeze
+
+      def initialize(api_url: API_URL, timeout: 30)
+        @api_url = api_url.chomp('/')
+        @timeout = timeout
+      end
+
+      def call(path, params = {})
+        params = params.compact
+        params['system'] = SYSTEM
+
+        apply_auth(params)
+
+        uri = URI.parse("#{@api_url}/#{path}.json")
+
+        Net::HTTP.start(uri.host, uri.port,
+          use_ssl:      true,
+          verify_mode:  OpenSSL::SSL::VERIFY_PEER,
+          open_timeout: @timeout,
+          read_timeout: @timeout
+        ) do |http|
+          request = Net::HTTP::Post.new(uri, build_headers)
+          request.body = params.to_json
+
+          response = http.request(request)
+
+          unless response.is_a?(Net::HTTPSuccess)
+            raise SerwerSMS::Error.new("HTTP #{response.code}", response.code)
+          end
+
+          result = JSON.parse(response.body)
+
+          if result.is_a?(Hash) && result['error']
+            raise SerwerSMS::Error.new(
+              result.dig('error', 'message') || 'Unknown API error',
+              result.dig('error', 'code')
+            )
+          end
+
+          result
+        end
+      end
+
+      private
+
+      def apply_auth(_params)
+        raise NotImplementedError, "#{self.class}#apply_auth not implemented"
+      end
+
+      def build_headers
+        { 'Content-Type' => 'application/json' }
+      end
+    end
+  end
+end

data/lib/serwersms/http/http_credentials.rb

@@ -0,0 +1,22 @@
+module SerwerSMS
+  module Http
+    class HttpCredentials < ApiClient
+      def initialize(username:, password:, **opts)
+        raise SerwerSMS::Error, 'Username is empty' if username.to_s.strip.empty?
+        raise SerwerSMS::Error, 'Password is empty' if password.to_s.strip.empty?
+
+        super(**opts)
+
+        @username = username
+        @password = password
+      end
+
+      private
+
+      def apply_auth(params)
+        params['username'] = @username
+        params['password'] = @password
+      end
+    end
+  end
+end

data/lib/serwersms/http/http_token.rb

@@ -0,0 +1,23 @@
+module SerwerSMS
+  module Http
+    class HttpToken < ApiClient
+      def initialize(token:, **opts)
+        raise SerwerSMS::Error, 'Token is empty' if token.to_s.strip.empty?
+
+        super(**opts)
+
+        @token = token
+      end
+
+      private
+
+      def apply_auth(_params)
+        # token przekazywany przez nagłówek Authorization, nie w body
+      end
+
+      def build_headers
+        super.merge('Authorization' => "Bearer #{@token}")
+      end
+    end
+  end
+end

data/lib/serwersms/resources/accounts.rb

@@ -0,0 +1,59 @@
+module SerwerSMS
+  module Resources
+    class Accounts
+      def initialize(client)
+        @client = client
+      end
+
+      # Register new account
+      #
+      # @param params [Hash]
+      #   @option params [String] :phone
+      #   @option params [String] :email
+      #   @option params [String] :first_name
+      #   @option params [String] :last_name
+      #   @option params [String] :company
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def add(params = {})
+        @client.call('account/add', params)
+      end
+
+      # Return SMS limits for account
+      #
+      # @return [Hash]
+      #   @option return [Array] :items
+      #     @option item [String] :type       Type of message
+      #     @option item [String] :chars_limit Maximum length of message
+      #     @option item [String] :value       Limit messages
+      def limits(params = {})
+        @client.call('account/limits', params)
+      end
+
+      # Return contact details
+      #
+      # @return [Hash]
+      #   @option return [String] :telephone
+      #   @option return [String] :email
+      #   @option return [String] :form
+      #   @option return [String] :faq
+      #   @option return [Hash]   :guardian_account
+      #     @option guardian_account [String] :name
+      #     @option guardian_account [String] :email
+      #     @option guardian_account [String] :telephone
+      #     @option guardian_account [String] :photo
+      def help(params = {})
+        @client.call('account/help', params)
+      end
+
+      # Return messages from the administrator
+      #
+      # @return [Hash]
+      #   @option return [Boolean] :new     Marking unread message
+      #   @option return [String]  :message
+      def messages(params = {})
+        @client.call('account/messages', params)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/blacklist.rb

@@ -0,0 +1,55 @@
+module SerwerSMS
+  module Resources
+    class Blacklist
+      def initialize(client)
+        @client = client
+      end
+
+      # Add phone to the blacklist
+      #
+      # @param phone [String]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def add(phone)
+        @client.call('blacklist/add', 'phone' => phone)
+      end
+
+      # List of blacklisted phones
+      #
+      # @param phone  [String]
+      # @param params [Hash]
+      #   @option params [Integer] :page  The number of the displayed page
+      #   @option params [Integer] :limit Limit items displayed on single page
+      # @return [Hash]
+      #   @option return [Hash]  :paging
+      #     @option paging [Integer] :page  The number of current page
+      #     @option paging [Integer] :count The number of all pages
+      #   @option return [Array] :items
+      #     @option item [String] :phone
+      #     @option item [String] :added Date of adding phone
+      def index(phone = nil, params = {})
+        params['phone'] = phone
+        @client.call('blacklist/index', params)
+      end
+
+      # Check if phone is blacklisted
+      #
+      # @param phone [String]
+      # @return [Hash]
+      #   @option return [Boolean] :exists
+      def check(phone)
+        @client.call('blacklist/check', 'phone' => phone)
+      end
+
+      # Delete phone from the blacklist
+      #
+      # @param phone [String]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def delete(phone)
+        @client.call('blacklist/delete', 'phone' => phone)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/contacts.rb

@@ -0,0 +1,134 @@
+module SerwerSMS
+  module Resources
+    class Contacts
+      def initialize(client)
+        @client = client
+      end
+
+      # Add new contact
+      #
+      # @param group_id [Integer]
+      # @param phone    [String]
+      # @param params   [Hash]
+      #   @option params [String] :email
+      #   @option params [String] :first_name
+      #   @option params [String] :last_name
+      #   @option params [String] :company
+      #   @option params [String] :tax_id
+      #   @option params [String] :address
+      #   @option params [String] :city
+      #   @option params [String] :description
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def add(group_id, phone, params = {})
+        params['group_id'] = group_id
+        params['phone']    = phone
+        @client.call('contacts/add', params)
+      end
+
+      # List of contacts
+      #
+      # @param group_id [Integer]
+      # @param search   [String]
+      # @param params   [Hash]
+      #   @option params [Integer] :page  The number of the displayed page
+      #   @option params [Integer] :limit Limit items displayed on single page
+      #   @option params [String]  :sort  Values: first_name|last_name|phone|company|tax_id|email|address|city|description
+      #   @option params [String]  :order Values: asc|desc
+      # @return [Hash]
+      #   @option return [Hash]  :paging
+      #     @option paging [Integer] :page  The number of current page
+      #     @option paging [Integer] :count The number of all pages
+      #   @option return [Array] :items
+      #     @option item [Integer] :id
+      #     @option item [String]  :phone
+      #     @option item [String]  :email
+      #     @option item [String]  :company
+      #     @option item [String]  :first_name
+      #     @option item [String]  :last_name
+      #     @option item [String]  :tax_id
+      #     @option item [String]  :address
+      #     @option item [String]  :city
+      #     @option item [String]  :description
+      #     @option item [Boolean] :blacklist
+      #     @option item [Integer] :group_id
+      #     @option item [String]  :group_name
+      def index(group_id = nil, search = nil, params = {})
+        params['group_id'] = group_id.nil? ? 'none' : group_id
+        params['search']   = search
+        @client.call('contacts/index', params)
+      end
+
+      # View single contact
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      #   @option return [Integer] :id
+      #   @option return [String]  :phone
+      #   @option return [String]  :email
+      #   @option return [String]  :company
+      #   @option return [String]  :first_name
+      #   @option return [String]  :last_name
+      #   @option return [String]  :tax_id
+      #   @option return [String]  :address
+      #   @option return [String]  :city
+      #   @option return [String]  :description
+      #   @option return [Boolean] :blacklist
+      def view(id)
+        @client.call('contacts/view', 'id' => id)
+      end
+
+      # Edit a contact
+      #
+      # @param id       [Integer]
+      # @param group_id [Integer, Array]
+      # @param phone    [String]
+      # @param params   [Hash]
+      #   @option params [String] :email
+      #   @option params [String] :first_name
+      #   @option params [String] :last_name
+      #   @option params [String] :company
+      #   @option params [String] :tax_id
+      #   @option params [String] :address
+      #   @option params [String] :city
+      #   @option params [String] :description
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def edit(id, group_id, phone, params = {})
+        params['id']       = id
+        params['group_id'] = group_id
+        params['phone']    = phone
+        @client.call('contacts/edit', params)
+      end
+
+      # Delete a contact
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def delete(id)
+        @client.call('contacts/delete', 'id' => id)
+      end
+
+      # Import contact list
+      #
+      # @param group_name [String]
+      # @param contact    [Array]
+      #   @option contact [String] :phone
+      #   @option contact [String] :email
+      #   @option contact [String] :first_name
+      #   @option contact [String] :last_name
+      #   @option contact [String] :company
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      #   @option return [Integer] :correct Number of contacts imported correctly
+      #   @option return [Integer] :failed  Number of errors
+      def import(group_name, contact = [])
+        @client.call('contacts/import', 'group_name' => group_name, 'contact' => contact)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/error.rb

@@ -0,0 +1,20 @@
+module SerwerSMS
+  module Resources
+    class Error
+      def initialize(client)
+        @client = client
+      end
+
+      # Preview error details
+      #
+      # @param code [Integer]
+      # @return [Hash]
+      #   @option return [Integer] :code
+      #   @option return [String]  :type
+      #   @option return [String]  :message
+      def view(code)
+        @client.call("error/#{code}")
+      end
+    end
+  end
+end

data/lib/serwersms/resources/files.rb

@@ -0,0 +1,61 @@
+module SerwerSMS
+  module Resources
+    class Files
+      def initialize(client)
+        @client = client
+      end
+
+      # Add new file
+      #
+      # @param type   [String] mms|voice
+      # @param params [Hash]
+      #   @option params [String] :url  URL address to file
+      #   @option params [String] :name File name
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [String]  :id
+      def add(type, params = {})
+        params['type'] = type
+        @client.call('files/add', params)
+      end
+
+      # List of files
+      #
+      # @param type [String] mms|voice
+      # @return [Hash]
+      #   @option return [Array] :items
+      #     @option item [String]  :id
+      #     @option item [String]  :name
+      #     @option item [Integer] :size
+      #     @option item [String]  :type mms|voice
+      #     @option item [String]  :date
+      def index(type)
+        @client.call('files/index', 'type' => type)
+      end
+
+      # View file details
+      #
+      # @param id   [String]
+      # @param type [String] mms|voice
+      # @return [Hash]
+      #   @option return [String]  :id
+      #   @option return [String]  :name
+      #   @option return [Integer] :size
+      #   @option return [String]  :type mms|voice
+      #   @option return [String]  :date
+      def view(id, type)
+        @client.call('files/view', 'id' => id, 'type' => type)
+      end
+
+      # Delete a file
+      #
+      # @param id   [String]
+      # @param type [String] mms|voice
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def delete(id, type)
+        @client.call('files/delete', 'id' => id, 'type' => type)
+      end
+    end
+  end
+end

data/lib/serwersms/resources/groups.rb

@@ -0,0 +1,83 @@
+module SerwerSMS
+  module Resources
+    class Groups
+      def initialize(client)
+        @client = client
+      end
+
+      # Add new group
+      #
+      # @param name [String]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def add(name)
+        @client.call('groups/add', 'name' => name)
+      end
+
+      # List of groups
+      #
+      # @param search [String] Group name filter
+      # @param params [Hash]
+      #   @option params [Integer] :page  The number of the displayed page
+      #   @option params [Integer] :limit Limit items displayed on single page
+      #   @option params [String]  :sort  Values: name
+      #   @option params [String]  :order Values: asc|desc
+      # @return [Hash]
+      #   @option return [Hash]  :paging
+      #     @option paging [Integer] :page  The number of current page
+      #     @option paging [Integer] :count The number of all pages
+      #   @option return [Array] :items
+      #     @option item [Integer] :id
+      #     @option item [String]  :name
+      #     @option item [Integer] :count Number of contacts in the group
+      def index(search = nil, params = {})
+        params['search'] = search
+        @client.call('groups/index', params)
+      end
+
+      # View single group
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      #   @option return [Integer] :id
+      #   @option return [String]  :name
+      #   @option return [Integer] :count Number of contacts in the group
+      def view(id)
+        @client.call('groups/view', 'id' => id)
+      end
+
+      # Edit a group
+      #
+      # @param id   [Integer]
+      # @param name [String]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      #   @option return [Integer] :id
+      def edit(id, name)
+        @client.call('groups/edit', 'id' => id, 'name' => name)
+      end
+
+      # Delete a group
+      #
+      # @param id [Integer]
+      # @return [Hash]
+      #   @option return [Boolean] :success
+      def delete(id)
+        @client.call('groups/delete', 'id' => id)
+      end
+
+      # View groups containing phone number
+      #
+      # @param phone [String]
+      # @return [Hash]
+      #   @option return [Array] :items
+      #     @option item [Integer] :id
+      #     @option item [Integer] :group_id
+      #     @option item [String]  :group_name
+      def check(phone)
+        @client.call('groups/check', 'phone' => phone)
+      end
+    end
+  end
+end