lifecell_api 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bc9d7e6af4706e51d9547c821cb7167c15f2ac837bc44b7b85939608622e66b8
+  data.tar.gz: 859f0f786da1feb7255b04b6c301b41dc0390293e9b397059f1c2503fe43fde3
+SHA512:
+  metadata.gz: '0649856738cc83c20f024ca748bfcf0c8e6fda2f6d2fad044c3b76b60d42921679d8775f7825c7a5b5db5ba4a24f365656e481ab2d1d4d508a93e3bd9ccaa341'
+  data.tar.gz: e6c9afdac89deffa06cb70d67f550830857c6df157427589a76c187039b343f9132814b42069d1b2c1c45b44b58b4f4d609ed681ac6d11fa3cf4ab9d32727c13

data/.gitignore

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

data/.ruby-version

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2018 Anton Maminov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,209 @@
+# lifecell::API
+
+A Ruby library for interfacing with lifecell's undocumented/unannounced API.
+
+[lifecell](http://lifecell.com.ua) — GSM operator in Ukraine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'lifecell_api'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install lifecell_api
+```
+
+## Usage
+
+First of all require the `lifecell_api` library.
+
+```ruby
+require 'lifecell_api'
+```
+
+### Authentication
+
+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 the country code("380"), and SuperPassword(`password`).
+
+```ruby
+msisdn = '38063xxxxxxx'
+password = 'xxxxxx'
+
+life = Lifecell::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 PAROL to number 123.
+
+or
+
+```ruby
+life = Lifecell::API.new
+life.token = token
+life.sub_id = sub_id
+```
+
+Now you can make requests to the API.
+
+### API Examples
+
+Below you can see some the methods for working with life:) data.
+
+#### Returns advanced information on the current subscriber
+```
+life.summary_data
+```
+
+Sample response
+
+```
+{"method"=>"getSummaryData",
+ "responseCode"=>"0",
+ "subscriber"=>
+  {"attribute"=>
+    [{"name"=>"ICCID", "content"=>"89380062300016907xxx"},
+     {"name"=>"PUK", "content"=>"25159xxx"},
+     {"name"=>"PUK2", "content"=>"00036xxx"},
+     {"name"=>"PIN2", "content"=>"55xx"},
+     {"name"=>"IMSI", "content"=>"25506109310xxxx"},
+     {"name"=>"PIN", "content"=>"70xx"},
+     {"name"=>"LINE_STATE", "content"=>"ACT/STD"},
+     {"name"=>"USE_COMMON_MAIN", "content"=>"false"},
+     {"name"=>"LINE_ACTIVATION_DATE",
+      "content"=>"2010-03-02T11:28:07.392+02:00"},
+     {"name"=>"LANGUAGE_ID", "content"=>"uk_tr"},
+     {"name"=>"DEVICE_NAME", "content"=>"HTC Sensation (PG58130)"},
+     {"name"=>"LINE_SUSPEND_DATE", "content"=>"2014-03-21T00:00:00+02:00"}],
+   "balance"=>
+    [{"code"=>"Line_Main", "amount"=>"12.83"},
+     {"code"=>"Line_Bonus", "amount"=>"0.00"},
+     {"code"=>"Line_Debt", "amount"=>"0.00"}],
+   "bundleFreeMigration"=>{"amount"=>"0"},
+   "tariff"=>{"code"=>"IND_PRE_YOUTH", "name"=>"Crazy day"}}}
+```
+
+#### Returns the balance of the current subscriber
+
+```
+life.balances
+```
+
+Sample response
+
+```
+{"method"=>"getBalances",
+ "responseCode"=>"0",
+ "balance"=>
+  [{"code"=>"Bundle_Gprs_Internet",
+    "amount"=>"0.00",
+    "measure"=>"Bytes",
+    "name"=>"Free Internet"},
+   {"code"=>"Bundle_Gprs_Wap",
+    "amount"=>"0.00",
+    "measure"=>"Bytes",
+    "name"=>"Free Internet [WAP]"},
+   {"code"=>"Bundle_Gprs_Internet_Youth",
+    "amount"=>"32624640.00",
+    "measure"=>"Bytes",
+    "name"=>"Internet [Crazy Day]"},
+   {"code"=>"Bundle_Usage_Internet_Weekly",
+    "amount"=>"0.00",
+    "measure"=>"Bytes",
+    "name"=>"Used Internet [Week]"},
+   {"code"=>"Bundle_Mms_Ukraine",
+    "amount"=>"0.00",
+    "measure"=>"MMS",
+    "name"=>"Free MMS [in Ukraine]"},
+   {"code"=>"Bundle_Sms_Ukraine",
+    "amount"=>"40.00",
+    "measure"=>"SMS",
+    "name"=>"Free SMS [in Ukraine]"},
+   {"code"=>"Bundle_Youth_Voice_Omo_Pstn",
+    "amount"=>"2160.00",
+    "measure"=>"Seconds",
+    "name"=>"100 min «life:) Сrazy day maximum» [other mob operators]"},
+   {"code"=>"Bundle_UsageN_FF_FREE",
+    "amount"=>"0.00",
+    "measure"=>"Seconds",
+    "name"=>"Free minutes [Family Numbers]"},
+   {"code"=>"Bundle_UsageN_Onnet_Region",
+    "amount"=>"0.00",
+    "measure"=>"Seconds",
+    "name"=>"Free minutes [Free life:) Donbas]"},
+   {"code"=>"Bundle_Voice_Onnet",
+    "amount"=>"24000.00",
+    "measure"=>"Seconds",
+    "name"=>"Free minutes [life:) network]"},
+   {"code"=>"Bundle_Voice_Offnet",
+    "amount"=>"0.00",
+    "measure"=>"Seconds",
+    "name"=>
+     "Free minutes [other mobile operators and fixed numbers of Ukraine]"},
+{"code"=>"Line_Bonus",
+    "amount"=>"0.00",
+    "measure"=>"UAH",
+    "name"=>"Line Bonus"},
+   {"code"=>"Line_Main",
+    "amount"=>"12.83",
+    "measure"=>"UAH",
+    "name"=>"Line Main"}]}
+```
+
+#### Returns payments history for calendar month in format 'YYYY-mm'
+
+```
+life.payments_history('2013-03')
+```
+
+Sample response
+
+```
+{"method"=>"getPaymentsHistory",
+ "responseCode"=>"0",
+ "payments"=>
+  {"sum"=>"50.00",
+   "payment"=>
+    [{"date"=>"2013-03-21",
+      "time"=>"10:40:12",
+      "type"=>"Payment via WEB",
+      "sum"=>"10.00"},
+     {"date"=>"2013-03-21",
+      "time"=>"13:25:28",
+      "type"=>"Payment via WEB",
+      "sum"=>"40.00"}]}}
+```
+
+## Supported Rubies
+
+Tested with the following Ruby versions:
+
+* MRI 2.5.0
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License and Author
+
+Copyright (c) 2013-2018 by Anton Maminov
+
+This library is distributed under the MIT license. Please see the LICENSE file.

data/Rakefile

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

data/examples/get_balance.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'bundler'
+Bundler.setup :default
+
+require 'logger'
+require 'lifecell_api'
+
+puts Lifecell::API::VERSION
+
+msisdn = '38xxxxxxxxx'
+password = 'xxxxxx'
+
+life = Lifecell::API.new(msisdn: msisdn, password: password, lang: 'en')
+life.log = Logger.new($stderr)
+life.sign_in
+
+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')
+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']
+puts "Main: #{main} ₴"
+puts "Bonus: #{bonus} ₴"
+puts "Dept: #{debt} ₴"
+
+puts "\nBalances:"
+balances =  life.balances
+balances['balance'].keep_if { |i| i['amount'].to_i != 0 }.each do |i|
+  puts " * #{i['name']}: #{i['amount']} #{i['measure']}"
+end
+
+life.sign_out

data/lib/lifecell_api.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require 'uri'
+require 'cgi'
+require 'net/https'
+require 'openssl'
+require 'base64'
+
+require 'xmlsimple'
+
+require 'lifecell_api/methods'
+require 'lifecell_api/version'
+
+# The Lifecell::API library is used for interactions with a https://api.life.com.ua.
+# lifecell - GSM operator in Ukraine
+#
+# == Example
+#
+#   require 'lifecell_api'
+#   require 'logger'
+#
+#   life = Lifecell::API.new(msisdn: msisdn, password: password, lang: 'uk')
+#   life.log = Logger.new($stderr)
+#   life.sign_in
+#   life.get_summary_data
+#   life.sign_out
+#
+module Lifecell
+  class MethodError < ArgumentError; end
+
+  RESPONSE_CODES = {
+    '0' => 'SUCCESSFULY_PERFORMED',
+    '-1' => 'METHOD_INVOCATION_TIMEOUT',
+    '-2' => 'INTERNAL_ERROR',
+    '-3' => 'INVALID_PARAMETERS_LIST',
+    '-4' => 'VENDOR_AUTHORIZATION_FAILED',
+    '-5' => 'VENDOR_ACCESS_KEY_EXPIRED',
+    '-6' => 'VENDOR_AUTHENTICATION_FAILED',
+    '-7' => 'SUPERPASS_CHECKING_FAILED',
+    '-8' => 'INCORRECT_SUBSCRIBER_ID',
+    '-9' => 'INCORRECT_SUBSRIBER_STATE',
+    '-10' => 'SUPERPASS_BLOCKED',
+    '-11' => 'SUBSCRIBER_ID_NOT_FOUND',
+    '-12' => 'TOKEN_EXPIRED',
+    '-13' => 'CHANGE_TARIFF_FAILED',
+    '-14' => 'SERVICE_ACTIVATION_FAILED',
+    '-15' => 'OFFER_ACTIVATION_FAILED',
+    '-16' => 'GET_TARIFFS_FAILED',
+    '-17' => 'GET_SERVICES_FAILED',
+    '-18' => 'REMOVE_SERVICE_FROM_PREPROCESSING_FAILED',
+    '-19' => 'LOGIC_IS_BLOCKING',
+    '-20' => 'TOO_MANY_REQUESTS',
+    '-40' => 'PAYMENTS_OR_EXPENSES_MISSED',
+    '-21474833648' => 'INTERNAL_APPLICATION_ERROR'
+  }.freeze
+
+  # :nodoc:
+  class API
+    attr_accessor :token, :sub_id
+
+    class << self
+      # Default logger for all Lifecell::API instances
+      #
+      #   Lifecell::API.log = Logger.new($stderr)
+      #
+      attr_accessor :log
+    end
+
+    # Create a new API object using the given parameters.
+    #
+    # == Required parameters
+    #
+    # * +:msisdn+ - telephone number in format '38063*******'
+    # * +:password+ - super password
+    # * +:lang+ - 'uk', 'ru' or 'en'
+    #
+    def initialize(params = {})
+      @msisdn   = params.delete(:msisdn)
+      @password = params.delete(:password)
+      @lang     = params.delete(:lang) || 'uk'
+
+      @log = nil
+
+      @os_type = 'ANDROID'
+
+      @api_url         = 'https://api.life.com.ua/mobile/'
+      @access_key_code = '7'
+      @application_key = 'E6j_$4UnR_)0b'
+    end
+
+    # The current logger. If no logger has been set Lifecell::API.log is used.
+    #
+    def log
+      @log || Lifecell::API.log
+    end
+
+    # Sets the +logger+ used by this instance of Lifecell::API
+    #
+    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}")
+
+      response = response(url)
+
+      log&.debug("[#{method}] response: #{response.body}")
+
+      xml = parse_xml(response.body)
+      return xml if xml['responseCode'] == '0'
+      raise_error!(xml)
+    end
+
+    private
+
+    def raise_error!(xml)
+      raise MethodError, "Unknown error: #{xml}" unless xml['responseCode']
+
+      error_message = Lifecell::RESPONSE_CODES[xml['responseCode']]
+      error_message ||= "Unknown error code #{xml['responseCode']}"
+      raise MethodError, error_message
+    end
+
+    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)
+      str = method + '?' + query + '&signature='
+
+      digest = OpenSSL::Digest.new('sha1')
+      hash = OpenSSL::HMAC.digest(digest, @application_key, str)
+
+      hash = Base64.encode64(hash).chomp
+
+      str += urlencode(hash)
+
+      @api_url + str
+    end
+
+    # 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)}"
+      end.sort * '&'
+    end
+
+    # URL-encode a string
+    def urlencode(str)
+      CGI.escape(str.to_s)
+    end
+
+    def parse_xml(str)
+      XmlSimple.xml_in(str, 'ForceArray' => false)
+    end
+
+    def base_api_parameters
+      { msisdn: @msisdn, languageId: @lang, osType: @os_type, token: @token }
+    end
+  end
+end

data/lib/lifecell_api/methods.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+# The list of available API method names:
+# (16/22)
+#
+# [-] activateDeactivateService
+# [+] callMeBack
+# [+] changeLanguage
+# [+] changeSuperPassword
+# [-] changeTariff
+# [+] getAvailableTariffs
+# [+] getBalances
+# [+] getExpensesSummary
+# [+] getLanguages
+# [+] getPaymentsHistory
+# [-] getSeparateBalances
+# [+] getServices
+# [+] getSummaryData
+# [+] getToken
+# [+] getUIProperties
+# [-] offerAction
+# [+] refillBalanceByScratchCard
+# [-] removeFromPreProcessing
+# [+] requestBalanceTransfer
+# [+] signIn
+# [+] signOut
+# [-] transferBalance
+
+# :nodoc:
+module Lifecell
+  # :nodoc:
+  class API
+    def sign_in
+      xml = request('signIn', msisdn: @msisdn, superPassword: @password)
+      @token  = xml['token']
+      @sub_id = xml['subId']
+      xml
+    end
+
+    def sign_out
+      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
+        )
+      )
+    end
+
+    def token
+      request(
+        'getToken',
+        msisdn: @msisdn, subId: @sub_id
+      )
+    end
+
+    # +last_date_update+ is DateTime object
+    #
+    def ui_properties(language_id, last_date_update)
+      request(
+        'getUIProperties',
+        accessKeyCode:  @access_key_code,
+        languageId:     language_id,
+        osType:         @os_type,
+        lastDateUpdate: last_date_update
+      )
+    end
+
+    def summary_data
+      request(
+        'getSummaryData',
+        base_api_parameters
+      )
+    end
+
+    def services
+      request('getServices', base_api_parameters)
+    end
+
+    def available_tariffs
+      request(
+        'getAvailableTariffs',
+        base_api_parameters
+      )
+    end
+
+    def balances
+      request(
+        'getBalances',
+        base_api_parameters
+      )
+    end
+
+    def languages
+      request(
+        'getLanguages',
+        base_api_parameters
+      )
+    end
+
+    def change_language(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)
+      )
+    end
+
+    def request_balance_transfer(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 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 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)
+      )
+    end
+  end
+end

data/lib/lifecell_api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Lifecell
+  class API
+    VERSION = '0.4.0'
+  end
+end

data/lifecell_api.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lifecell_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'lifecell_api'
+  gem.version = Lifecell::API::VERSION
+  gem.authors = ['Anton Maminov']
+  gem.email = ['anton.maminov@gmail.com']
+  gem.description = 'A Ruby interface to the lifecell API'
+  gem.summary = <<-SUMMARY
+    The Life::API library is used for interactions
+    with api.life.com.ua
+  SUMMARY
+  gem.homepage = 'https://github.com/mamantoha/lifecell_api'
+  gem.license = 'MIT'
+
+  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.add_runtime_dependency('xml-simple', '~> 1.1.2')
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('rubocop')
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: lifecell_api
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Anton Maminov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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 lifecell API
+email:
+- anton.maminov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/get_balance.rb
+- lib/lifecell_api.rb
+- lib/lifecell_api/methods.rb
+- lib/lifecell_api/version.rb
+- lifecell_api.gemspec
+homepage: https://github.com/mamantoha/lifecell_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: The Life::API library is used for interactions with api.life.com.ua
+test_files: []