life-api 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: da009a2372ce299d656a0cdb99331a4c91c75e23
-  data.tar.gz: 4c956cdb158ab68669badb15bba6480ba9e8e824
+SHA256:
+  metadata.gz: 3ab973f0fa83d1c3ec3d65e7616dbdaabb750617b29dc2fa22fca5512dfb8c87
+  data.tar.gz: a6a8efe3674708ad92dc25508a397ad25e0fe92b460e12a93a9a87b5d66268ce
 SHA512:
-  metadata.gz: a4a8acdc289d333e7f19f2fb7300b7bbe570da378d132a70edc77b1c15d13aa6706b37f6634efbe26600544e903b4ef8d610a26bd87ad1a4447d244e84e39a78
-  data.tar.gz: 70c680fd0ba26ed01ec0cb403c75949dc9c161806d46046dce8dd8d994d25327a2c6c87d2461ec5054212cf1dfc4e50d027adad64263e1a530ea5de051424c7a
+  metadata.gz: c52dbd3a68326cf970ea9ea88def6e674452a6d90654d1086b2029050d02800fcf9880dbe899906663932fb0ce50dc85a41535ac54694012898ec6f8070ffee5
+  data.tar.gz: 6240318d52c514efc60d73c299b80a0bb8de6e60f19c497ffa953dacd774f2f472a8096f30ef07aa031cdcd5b98db345e2214def14bf7cbd45fae2f5199ca3da

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in life-api.gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Anton Maminov
+Copyright (c) 2013-2018 Anton Maminov
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,8 +1,8 @@
 # Life::API
 
-A Ruby library for interfacing with life:)'s undocumented/unannounced API.
+A Ruby library for interfacing with lifecell's undocumented/unannounced API.
 
-[life:)](http://life.com.ua) — GSM operator in Ukraine.
+[lifecell](http://lifecell.com.ua) — GSM operator in Ukraine.
 
 ## Installation
 
@@ -36,16 +36,19 @@ require 'life-api'
 
 You can authenticate with life:) in two ways: with password or with token.
 
-Authentication with password to the life:) API is accomplished using a phone number(`msisdn`) starting with a plus sign ("+") and the country code("380"), and SuperPassword(`password`).
+Authentication with password to the life:) API is accomplished using a phone number(`msisdn`) starting with the country code("380"), and SuperPassword(`password`).
 
 ```ruby
+msisdn = '38063xxxxxxx'
+password = 'xxxxxx'
+
 life = Life::API.new(msisdn: msisdn, password: password)
 life.sign_in
 token = life.token
 sub_id = life.sub_id
 ```
 
-> To obtain the SuperPassword send an SMS with key word PASSWORD to number 125, or enter life:) menu by dialing `*125#`, choose Manage account and then SuperPassword service or call `*125*779#`.
+> To obtain the SuperPassword send an SMS with key word PAROL to number 123.
 
 or
 
@@ -63,7 +66,7 @@ Below you can see some the methods for working with life:) data.
 
 #### Returns advanced information on the current subscriber
 ```
-life.get_summary_data
+life.summary_data
 ```
 
 Sample response
@@ -97,7 +100,7 @@ Sample response
 #### Returns the balance of the current subscriber
 
 ```
-life.get_balances
+life.balances
 ```
 
 Sample response
@@ -164,7 +167,7 @@ Sample response
 #### Returns payments history for calendar month in format 'YYYY-mm'
 
 ```
-life.get_payments_history('2013-03')
+life.payments_history('2013-03')
 ```
 
 Sample response
@@ -189,8 +192,7 @@ Sample response
 
 Tested with the following Ruby versions:
 
-* MRI 1.9.3
-* MRI 2.0.0
+* MRI 2.3.0
 
 ## Contributing
 
@@ -202,6 +204,6 @@ Tested with the following Ruby versions:
 
 ## License and Author
 
-Copyright (c) 2013-2015 by Anton Maminov
+Copyright (c) 2013-2018 by Anton Maminov
 
 This library is distributed under the MIT license. Please see the LICENSE file.

data/Rakefile

@@ -1 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/examples/get_balance.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'bundler'
 Bundler.setup :default
@@ -8,36 +8,35 @@ require 'life-api'
 
 puts Life::API::VERSION
 
-msisdn = '+38xxxxxxxxx'
-password = ''
+msisdn = '38xxxxxxxxx'
+password = 'xxxxxx'
 
 life = Life::API.new(msisdn: msisdn, password: password, lang: 'en')
 life.log = Logger.new($stderr)
 life.sign_in
 
-summary_data = life.get_summary_data
+summary_data = life.summary_data
 
 tariff = summary_data['subscriber']['tariff']['name']
 puts "Tariff: #{tariff}"
 
-line_suspend_date = summary_data['subscriber']['attribute'].select{ |f| f['name'] == "LINE_SUSPEND_DATE" }.first['content']
-line_suspend_date = Time.mktime(line_suspend_date).strftime("%d.%m.%Y")
+line_suspend_date = summary_data['subscriber']['attribute'].select { |f| f['name'] == 'LINE_SUSPEND_DATE' }.first['content']
+line_suspend_date = Time.mktime(line_suspend_date).strftime('%d.%m.%Y')
 puts "Suspend date: #{line_suspend_date}"
 
 puts
 
 balance = summary_data['subscriber']['balance']
-main = balance.select{ |f| f['code'] == 'Line_Main' }.first['amount']
-bonus =  balance.select{ |f| f['code'] == 'Line_Bonus' }.first['amount']
-debt =  balance.select{ |f| f['code'] == 'Line_Debt' }.first['amount']
+main = balance.select { |f| f['code'] == 'Line_Main' }.first['amount']
+bonus = balance.select { |f| f['code'] == 'Line_Bonus' }.first['amount']
+debt = balance.select { |f| f['code'] == 'Line_Debt' }.first['amount']
 puts "Main: #{main} ₴"
 puts "Bonus: #{bonus} ₴"
 puts "Dept: #{debt} ₴"
 
-
 puts "\nBalances:"
-balances =  life.get_balances
-balances['balance'].keep_if{ |i| i['amount'].to_i != 0 }.each do |i|
+balances =  life.balances
+balances['balance'].keep_if { |i| i['amount'].to_i != 0 }.each do |i|
   puts " * #{i['name']}: #{i['amount']} #{i['measure']}"
 end
 

data/lib/life-api.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'uri'
 require 'cgi'
@@ -8,11 +8,11 @@ require 'base64'
 
 require 'xmlsimple'
 
-require "life-api/methods"
-require "life-api/version"
+require 'life-api/methods'
+require 'life-api/version'
 
-# The Life::API library is used for interactions with a api.life.com.ua website.
-# life:) — GSM operator in Ukraine
+# The Life::API library is used for interactions with a https://api.life.com.ua.
+# lifecell - GSM operator in Ukraine
 #
 # == Example
 #
@@ -26,7 +26,6 @@ require "life-api/version"
 #   life.sign_out
 #
 module Life
-
   class MethodError < ArgumentError; end
 
   RESPONSE_CODES = {
@@ -52,9 +51,10 @@ module Life
     '-19' => 'LOGIC_IS_BLOCKING',
     '-20' => 'TOO_MANY_REQUESTS',
     '-40' => 'PAYMENTS_OR_EXPENSES_MISSED',
-    '-21474833648' => 'INTERNAL_APPLICATION_ERROR',
-  }
+    '-21474833648' => 'INTERNAL_APPLICATION_ERROR'
+  }.freeze
 
+  # :nodoc:
   class API
     attr_accessor :token, :sub_id
 
@@ -71,7 +71,7 @@ module Life
     # == Required parameters
     #
     # * +:msisdn+ - telephone number in format '38063*******'
-    # * +:password+ - life:) super password
+    # * +:password+ - super password
     # * +:lang+ - 'uk', 'ru' or 'en'
     #
     def initialize(params = {})
@@ -96,40 +96,41 @@ module Life
 
     # Sets the +logger+ used by this instance of Life::API
     #
-    def log= logger
-      @log = logger
-    end
+    attr_writer :log
 
     def request(method, params = {})
       params = { accessKeyCode: @access_key_code }.merge(params)
       url = create_signed_url(method, params)
 
-      log.debug("[#{method}] request: #{url}") if log
+      log&.debug("[#{method}] request: #{url}")
 
-      uri = URI(url)
-      request = Net::HTTP::Get.new(uri.request_uri)
+      response = response(url)
 
-      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
+      log&.debug("[#{method}] response: #{response.body}")
 
-      log.debug("[#{method}] response: #{response.body}") if log
+      xml = parse_xml(response.body)
+      return xml if xml['responseCode'] == '0'
+      raise_error!(xml)
+    end
 
-      xml =  parse_xml(response.body)
+    private
 
-      if xml['responseCode']
-        if xml['responseCode'] == '0'
-          return xml
-        else
-          error_message = Life::RESPONSE_CODES[xml['responseCode']]
-          error_message ||= "Unknown error code #{xml['responseCode']}"
-          raise MethodError, error_message
-        end
-      else
-        raise MethodError, "Unknown error: #{xml}"
-      end
+    def raise_error!(xml)
+      raise MethodError, "Unknown error: #{xml}" unless xml['responseCode']
 
+      error_message = Life::RESPONSE_CODES[xml['responseCode']]
+      error_message ||= "Unknown error code #{xml['responseCode']}"
+      raise MethodError, error_message
     end
 
-    private
+    def response(url)
+      uri = URI(url)
+      request = Net::HTTP::Get.new(uri.request_uri)
+
+      Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+    end
 
     def create_signed_url(method, params)
       query = create_param(params)
@@ -142,11 +143,11 @@ module Life
 
       str += urlencode(hash)
 
-      return @api_url + str
+      @api_url + str
     end
 
-    # Returns a string representation of the receiver suitable for use as a URL query string
-    #
+    # Returns a string representation of the receiver suitable for use
+    # as a URL query string
     def create_param(params)
       params.map do |key, value|
         "#{urlencode(key)}=#{urlencode(value)}"
@@ -154,18 +155,16 @@ module Life
     end
 
     # URL-encode a string
-    #
     def urlencode(str)
-      return CGI.escape(str.to_s)
+      CGI.escape(str.to_s)
     end
 
     def parse_xml(str)
-      return XmlSimple.xml_in(str, { 'ForceArray' => false })
+      XmlSimple.xml_in(str, 'ForceArray' => false)
     end
 
     def base_api_parameters
-      return { msisdn: @msisdn, languageId: @lang, osType: @os_type, token: @token }
+      { msisdn: @msisdn, languageId: @lang, osType: @os_type, token: @token }
     end
-
   end
 end

data/lib/life-api/methods.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 # The list of available API method names:
 # (16/22)
@@ -26,89 +26,134 @@
 # [+] signOut
 # [-] transferBalance
 
+# :nodoc:
 module Life
+  # :nodoc:
   class API
     def sign_in
-      xml = request('signIn', { msisdn: @msisdn, superPassword: @password })
+      xml = request('signIn', msisdn: @msisdn, superPassword: @password)
       @token  = xml['token']
       @sub_id = xml['subId']
-      return xml
+      xml
     end
 
     def sign_out
-      request('signOut', { msisdn: @msisdn, subId: @sub_id })
+      request(
+        'signOut',
+        msisdn: @msisdn,
+        subId: @sub_id
+      )
     end
 
     def change_super_password(old_password, new_password)
-      request('changeSuperPassword', base_api_parameters.merge({ oldPassword: old_password, newPassword: new_password }))
+      request(
+        'changeSuperPassword',
+        base_api_parameters.merge(
+          oldPassword: old_password,
+          newPassword: new_password
+        )
+      )
     end
 
-    def get_token
-      request('getToken', { msisdn: @msisdn, subId: @sub_id })
+    def token
+      request(
+        'getToken',
+        msisdn: @msisdn, subId: @sub_id
+      )
     end
 
     # +last_date_update+ is DateTime object
     #
-    def get_ui_properties(language_id, last_date_update)
-      request('getUIProperties', {
+    def ui_properties(language_id, last_date_update)
+      request(
+        'getUIProperties',
         accessKeyCode:  @access_key_code,
         languageId:     language_id,
         osType:         @os_type,
-        lastDateUpdate: last_date_update,
-      })
+        lastDateUpdate: last_date_update
+      )
     end
 
-    def get_summary_data
-      request('getSummaryData', base_api_parameters)
+    def summary_data
+      request(
+        'getSummaryData',
+        base_api_parameters
+      )
     end
 
-    def get_services
+    def services
       request('getServices', base_api_parameters)
     end
 
-    def get_available_tariffs
-      request('getAvailableTariffs', base_api_parameters)
+    def available_tariffs
+      request(
+        'getAvailableTariffs',
+        base_api_parameters
+      )
     end
 
-    def get_balances
-      request('getBalances', base_api_parameters)
+    def balances
+      request(
+        'getBalances',
+        base_api_parameters
+      )
     end
 
-    def get_languages
-      request('getLanguages', base_api_parameters)
+    def languages
+      request(
+        'getLanguages',
+        base_api_parameters
+      )
     end
 
     def change_language(new_language_id)
-      request('changeLanguage', base_api_parameters.merge({ newLanguageId: new_language_id}))
+      request(
+        'changeLanguage',
+        base_api_parameters.merge(newLanguageId: new_language_id)
+      )
     end
 
     def call_me_back(msisdn_b)
-      request('callMeBack', base_api_parameters.merge({ msisdnB: msisdn_b }))
+      request(
+        'callMeBack',
+        base_api_parameters.merge(msisdnB: msisdn_b)
+      )
     end
 
     def request_balance_transfer(msisdn_b)
-      request('requestBalanceTransfer', base_api_parameters.merge({ msisdnB: msisdn_b }))
+      request(
+        'requestBalanceTransfer',
+        base_api_parameters.merge(msisdnB: msisdn_b)
+      )
     end
 
     # Payments history for calendar month +month_period+
     #
     # +month_period+ - A string like 'yyyy-MM' that represent month of year
     #
-    def get_payments_history(month_period)
-      request('getPaymentsHistory', base_api_parameters.merge({ monthPeriod: month_period }))
+    def payments_history(month_period)
+      request(
+        'getPaymentsHistory',
+        base_api_parameters.merge(monthPeriod: month_period)
+      )
     end
 
     # Summary expenses report for calendar month +month_period+
     #
     # +month_period+ - A string like 'yyyy-MM' that represent month of year
     #
-    def get_expenses_summary(month_period)
-      request('getExpensesSummary', base_api_parameters.merge({ monthPeriod: month_period }))
+    def expenses_summary(month_period)
+      request(
+        'getExpensesSummary',
+        base_api_parameters.merge(monthPeriod: month_period)
+      )
     end
 
     def refill_balance_by_scratch_card(secret_code)
-      request('refillBalanceByScratchCard', base_api_parameters.merge({ secretCode: secret_code}))
+      request(
+        'refillBalanceByScratchCard',
+        base_api_parameters.merge(secretCode: secret_code)
+      )
     end
-
   end
 end

data/lib/life-api/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Life
   class API
-    VERSION = "0.1.5"
+    VERSION = '0.2.0'
   end
 end

data/life-api.gemspec

@@ -1,22 +1,25 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'life-api/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "life-api"
+  gem.name          = 'life-api'
   gem.version       = Life::API::VERSION
-  gem.authors       = ["Anton Maminov"]
-  gem.email         = ["anton.linux@gmail.com"]
-  gem.description   = %q{A Ruby interface to the life:) API}
-  gem.summary       = %q{The Life::API library is used for interactions with a api.life.com.ua website}
-  gem.homepage      = "https://github.com/mamantoha/life-api"
-  gem.license       = "MIT"
+  gem.authors       = ['Anton Maminov']
+  gem.email         = ['anton.maminov@gmail.com']
+  gem.description   = 'A Ruby interface to the life:) API'
+  gem.summary       = 'The Life::API library is used for interactions with a api.life.com.ua website'
+  gem.homepage      = 'https://github.com/mamantoha/life-api'
+  gem.license       = 'MIT'
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
   gem.add_runtime_dependency('xml-simple', '~> 1.1.2')
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('rubocop')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: life-api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton Maminov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2018-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
@@ -24,13 +24,43 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby interface to the life:) API
 email:
-- anton.linux@gmail.com
+- anton.maminov@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE
 - README.md
@@ -60,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: The Life::API library is used for interactions with a api.life.com.ua website