life-api 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da009a2372ce299d656a0cdb99331a4c91c75e23
+  data.tar.gz: 4c956cdb158ab68669badb15bba6480ba9e8e824
+SHA512:
+  metadata.gz: a4a8acdc289d333e7f19f2fb7300b7bbe570da378d132a70edc77b1c15d13aa6706b37f6634efbe26600544e903b4ef8d610a26bd87ad1a4447d244e84e39a78
+  data.tar.gz: 70c680fd0ba26ed01ec0cb403c75949dc9c161806d46046dce8dd8d994d25327a2c6c87d2461ec5054212cf1dfc4e50d027adad64263e1a530ea5de051424c7a

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 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,207 @@
+# Life::API
+
+A Ruby library for interfacing with life:)'s undocumented/unannounced API.
+
+[life:)](http://life.com.ua) — GSM operator in Ukraine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'life-api'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install life-api
+```
+
+## Usage
+
+First of all require the `life-api` library.
+
+```ruby
+require 'life-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 a plus sign ("+") and the country code("380"), and SuperPassword(`password`).
+
+```ruby
+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#`.
+
+or
+
+```ruby
+life = Life::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.get_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.get_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.get_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 1.9.3
+* MRI 2.0.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-2015 by Anton Maminov
+
+This library is distributed under the MIT license. Please see the LICENSE file.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/get_balance.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'bundler'
+Bundler.setup :default
+
+require 'logger'
+require 'life-api'
+
+puts Life::API::VERSION
+
+msisdn = '+38xxxxxxxxx'
+password = ''
+
+life = Life::API.new(msisdn: msisdn, password: password, lang: 'en')
+life.log = Logger.new($stderr)
+life.sign_in
+
+summary_data = life.get_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.get_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/life-api/methods.rb

@@ -0,0 +1,114 @@
+# encoding: utf-8
+
+# 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
+
+module Life
+  class API
+    def sign_in
+      xml = request('signIn', { msisdn: @msisdn, superPassword: @password })
+      @token  = xml['token']
+      @sub_id = xml['subId']
+      return 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 get_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', {
+        accessKeyCode:  @access_key_code,
+        languageId:     language_id,
+        osType:         @os_type,
+        lastDateUpdate: last_date_update,
+      })
+    end
+
+    def get_summary_data
+      request('getSummaryData', base_api_parameters)
+    end
+
+    def get_services
+      request('getServices', base_api_parameters)
+    end
+
+    def get_available_tariffs
+      request('getAvailableTariffs', base_api_parameters)
+    end
+
+    def get_balances
+      request('getBalances', base_api_parameters)
+    end
+
+    def get_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 get_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 }))
+    end
+
+    def refill_balance_by_scratch_card(secret_code)
+      request('refillBalanceByScratchCard', base_api_parameters.merge({ secretCode: secret_code}))
+    end
+
+  end
+end

data/lib/life-api/version.rb

@@ -0,0 +1,5 @@
+module Life
+  class API
+    VERSION = "0.1.5"
+  end
+end

data/lib/life-api.rb

@@ -0,0 +1,171 @@
+# encoding: utf-8
+
+require 'uri'
+require 'cgi'
+require 'net/https'
+require 'openssl'
+require 'base64'
+
+require 'xmlsimple'
+
+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
+#
+# == Example
+#
+#   require 'life-api'
+#   require 'logger'
+#
+#   life = Life::API.new(msisdn: msisdn, password: password, lang: 'uk')
+#   life.log = Logger.new($stderr)
+#   life.sign_in
+#   life.get_summary_data
+#   life.sign_out
+#
+module Life
+
+  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',
+  }
+
+  class API
+    attr_accessor :token, :sub_id
+
+    class << self
+      # Default logger for all Life::API instances
+      #
+      #   Life::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+ - life:) 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 Life::API.log is used.
+    #
+    def log
+      @log || Life::API.log
+    end
+
+    # Sets the +logger+ used by this instance of Life::API
+    #
+    def log= logger
+      @log = logger
+    end
+
+    def request(method, params = {})
+      params = { accessKeyCode: @access_key_code }.merge(params)
+      url = create_signed_url(method, params)
+
+      log.debug("[#{method}] request: #{url}") if log
+
+      uri = URI(url)
+      request = Net::HTTP::Get.new(uri.request_uri)
+
+      response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
+
+      log.debug("[#{method}] response: #{response.body}") if log
+
+      xml =  parse_xml(response.body)
+
+      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
+
+    end
+
+    private
+
+    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)
+
+      return @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)
+      return CGI.escape(str.to_s)
+    end
+
+    def parse_xml(str)
+      return XmlSimple.xml_in(str, { 'ForceArray' => false })
+    end
+
+    def base_api_parameters
+      return { msisdn: @msisdn, languageId: @lang, osType: @os_type, token: @token }
+    end
+
+  end
+end

data/life-api.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+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.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.files         = `git ls-files`.split($/)
+  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')
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: life-api
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Anton Maminov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-03 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
+description: A Ruby interface to the life:) API
+email:
+- anton.linux@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/get_balance.rb
+- lib/life-api.rb
+- lib/life-api/methods.rb
+- lib/life-api/version.rb
+- life-api.gemspec
+homepage: https://github.com/mamantoha/life-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.4.7
+signing_key: 
+specification_version: 4
+summary: The Life::API library is used for interactions with a api.life.com.ua website
+test_files: []