smsapi-client 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d3b9d0bfa832e3b08c12271a46baa9f3c2111a0
-  data.tar.gz: 970f448af0780ee8b96ef7fe0640804c81351962
+  metadata.gz: aca718d7c1299fa804479d64055ce5b67151e2bf
+  data.tar.gz: 4020f101559041a6f0ffcb2d13fa001f2e2a6cd0
 SHA512:
-  metadata.gz: 892fa8a907f6b9f6d3bf0f9aab3931ca3864f2abcde86143ceff4d76631b02be6ac21986c36181186814ad60d1171271614a5823ba68eb1616593032629e1e46
-  data.tar.gz: d09630489721bc5338010204b973719e79a3334c109c429bbd5d42277e299cf6b17beb6bc0522ffda329cd0c8cd8ac3bb9bd93f9834cc9ccc3fa3b733fd710ab
+  metadata.gz: 64e515e7620bf98aba7d37f151e843788d8bb80ce5ae6f40127d3c7199d6154ca38b7dea8bc7cec2d27e4f7349265740f3dd4bcb2cb8dd22eba8639fc4a81770
+  data.tar.gz: 028165990a2077b50c4c04ecab59b02203c896177ac0dfec54d7961f2b6762602afa4ff33b0a613160c93387b4a077e21180793703d5bd154cc20e1e2b33e6b8

data/README.md

@@ -5,7 +5,7 @@
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'smsapi-client', '~> 0.2'
+gem 'smsapi-client', '~> 0.3'
 ```
 
 And then execute:
@@ -14,7 +14,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install smsapi-client
+    $ gem install smsapi-client -v '~> 0.3'
 
 ## Usage
 
@@ -22,6 +22,15 @@ Or install it yourself as:
 # Create the client
 client = Smsapi::Client.new('username', 'password')
 
+# Get credits (account details)
+credits = client.credits
+credits.balance        # => 2.6600
+credits.pro_sms_limit  # => 16
+credits.eco_sms_limit  # => 38
+credits.mms_limit      # => 8
+credits.vms_gsm_limit  # => 26
+credits.vms_stac_limit # => 26
+
 # Send a single text message
 sms = client.send_single 500500500, 'Text Message'
 sms.status   # 'OK'

data/lib/smsapi/client.rb

@@ -1,23 +1,23 @@
 module Smsapi
   class Client
     def initialize(username, password)
-      @server = Server.new(username, password)
+      @server = Smsapi::Server.new(username, password)
+    end
+
+    def credits(options = {})
+      Smsapi::Credits.new(@server, options).check
     end
 
     def send_single(to, message, options = {})
-      SMS.new(to, message, @server, options).deliver
+      Smsapi::SMS.new(to, message, @server, options).deliver
     end
 
     def schedule_single(to, message, date, options = {})
-      SMS.new(to, message, @server, options).deliver_at(date)
+      Smsapi::SMS.new(to, message, @server, options).deliver_at(date)
     end
 
     def send_bulk(to, message, options = {})
-      BulkSMS.new(to, message, @server, options).deliver
-    end
-
-    def details
-      # not implemented
+      Smsapi::BulkSMS.new(to, message, @server, options).deliver
     end
   end
 end

data/lib/smsapi/credits.rb

@@ -0,0 +1,61 @@
+module Smsapi
+  class Credits
+
+    attr_accessor :status, :error_code, :balance, :pro_sms_limit, :eco_sms_limit, :mms_limit, :vms_gsm_limit, :vms_stac_limit
+    def initialize(server, options = {})
+      @options = default_options.merge options
+      @server = server
+    end
+
+    def check
+      read_response @server.user(server_params).join(';')
+      self
+    end
+
+    def sent?
+      not self.status.nil?
+    end
+
+    def error?
+      self.status == 'ERROR'
+    end
+
+    def success?
+      self.status == 'Points'
+    end
+
+    def error_message
+      Smsapi::ERROR_MESSAGES[error_code]
+    end
+
+    def read_response(response)
+      response = response.split(':').map(&:strip)
+
+      self.status = response[0]
+      if status == 'ERROR'
+        self.error_code = response[1]
+      else
+        data = response[1].split(';')
+        self.balance        = data[0].to_f
+        self.pro_sms_limit  = data[1].to_i
+        self.eco_sms_limit  = data[2].to_i
+        self.mms_limit      = data[3].to_i
+        self.vms_gsm_limit  = data[4].to_i
+        self.vms_stac_limit = data[5].to_i
+      end
+    end
+
+    private
+
+    def default_options
+      {
+        credits: 1,
+        details: 1
+      }
+    end
+
+    def server_params
+      @options
+    end
+  end
+end

data/lib/smsapi/defaults.rb

@@ -2,7 +2,7 @@ module Smsapi::Defaults
   def default_options
     {
       from: 'eco',
-      test: '1'
+      test: '0'
     }
   end
 end

data/lib/smsapi/server.rb

@@ -6,6 +6,11 @@ module Smsapi
       @connection = setup_connection
     end
 
+    def user(params = {})
+      api_response = make_request(Smsapi::API[:user_path], params)
+      api_response.split(';')
+    end
+
     def sms(params = {})
       api_response = make_request(Smsapi::API[:sms_path], params)
       api_response.split(';')

data/lib/smsapi/smsapi.rb

@@ -2,6 +2,7 @@ require 'smsapi/server'
 require 'smsapi/server/connection'
 require 'smsapi/client'
 require 'smsapi/defaults'
+require 'smsapi/credits'
 require 'smsapi/sms'
 require 'smsapi/bulk_sms'
 require 'smsapi/group_sms'
@@ -10,14 +11,16 @@ module Smsapi
   class Error < StandardError; end
   class ServerError < Error; end
 
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
   API = {
     uri: 'ssl.smsapi.pl',
     port: 443,
+    user_path: '/user.do',
     sms_path: '/sms.do'
   }
 
   ERROR_MESSAGES = {
     '101' => 'Bad Credentials',
+    '1001' => 'Bad Request Format'
   }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smsapi-client
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Alek Niemczyk
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-02 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,6 +59,7 @@ files:
 - bin/setup
 - lib/smsapi/bulk_sms.rb
 - lib/smsapi/client.rb
+- lib/smsapi/credits.rb
 - lib/smsapi/defaults.rb
 - lib/smsapi/group_sms.rb
 - lib/smsapi/server.rb