kaspay 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe31038fcff900af5444f5018b64e335bce662c6
-  data.tar.gz: 4db5d733155f0b6e3f57d3622d16a28e1faabfd7
+  metadata.gz: 43081c96cd556ee5cc3f775ef57e9b4b2f7139e9
+  data.tar.gz: be34341f29d037b715d41cb0fb2f4366c6975690
 SHA512:
-  metadata.gz: 1701cdb520bfbbb93e12d5af8f39f1b4bfaa6fb292a675fb251310c9b21fea74d98344d9cee01baf1546ad3aaf5b446b5e369c55b7a0e82e7f0e365a37569378
-  data.tar.gz: b74d09a869b6a16953bc53fd88d64cca14b4411c961ecac76b2feac2bbab0bd7e864f386cf499b4d6fd8f34892569b3fd8f07dbac2a34065c695eca347064f3b
+  metadata.gz: 2a2fc30b97487116b4761f12110d435d046da79e6d293aabde5f49ac014c821ecdecb17ef3c0964705c223b8ffc8f41ce39bab261eb375639869d8b3519df676
+  data.tar.gz: a81f7ade37886a8b8b9e0c5ca87b33532acdd96aaa41aca62ff88e9978b70445958af9362077f5d28d6375e1e6be5b1c0bcada06d77f7e3aec72f806f0bc5217

data/README.md

@@ -21,15 +21,34 @@ In `Gemfile`:
     gem 'kaspay'
 
 ## Examples
-###Code
+### Code
 ```ruby
 require 'kaspay'
 
 kaspay = KasPay.login email: "email@example.com", password: "yOurp@sSw0rD"
+# Alternative:
+# kaspay = KasPay.login
+# kaspay.email = "email@example.com"
+# kaspay.password = "yOurp@sSw0rD"
 puts "#{kaspay.get_name}'s savings with account number #{kaspay.get_acc_num}:"
+# `<method>` is an alias for `get_<method>`. So, you can use `kaspay.name` or `kaspay.acc_num` instead.
 puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
 puts " Bank A balance".ljust(15) + ": " + "Rp 500,000.00".rjust(20)
 puts " Bank B balance".ljust(15) + ": " + "Rp 600,000.00".rjust(20)
 puts " KasPay balance".ljust(15) + ": " + kaspay.get_balance.to_s.rjust(20)
 puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+puts " Total balance".ljust(15) + ": " + (kaspay.balance + 500000 + KasPay::Money.new(600000)).to_s.rjust(20)
+puts "~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
+kaspay.logout!
+```
+### Output  
+```ruby
+#=> John Doe's savings with account number 12345678:
+#=> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#=>  Bank A balance:        Rp 500,000.00
+#=>  Bank B balance:        Rp 600,000.00
+#=>  KasPay balance:        Rp 915,826.00
+#=> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+#=>  Total balance :      Rp 2,015,826.00
+#=> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 ```

data/lib/kaspay/version.rb

@@ -1,3 +1,3 @@
 class KasPay
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/kaspay.rb

@@ -1,55 +1,91 @@
 #!/usr/bin/env ruby
-
+# @author Adrian Setyadi
+# Copyright 2015
+# 
+require 'pstore'
 require 'watir'
 require 'headless'
 require_relative 'meta_stuff'
 require_relative 'kernel_patch'
 
 class KasPay
+   # Assign methods from MetaStuff module as KasPay class methods
    extend MetaStuff
 
+   # A bunch of constants belong to KasPay.
+   BASE_URL = "https://www.kaspay.com"
+   LOGIN_URL = BASE_URL + "/login" 
+   THINGS_TO_GET = %w(name balance acc_num).map(&:to_sym)
+   THE_GET_METHODS = add__get__to(THINGS_TO_GET)
+   DATA_DIR = ENV['HOME'] + "/.kaspay"
+   DATA_PATH = DATA_DIR + "/kaspay.dat"
+
+   # Opening KasPay class singleton scope
    class << self
-      static_pages = %w(about term)
+      
+      # A list of kaspay.com static pages to open for the sake of  
+      # the information.
+      static_pages = %w(about term) # more will come
+     
+      # Iterate through static pages list to make methods named the
+      # the same as the member of the list. These methods will be
+      # the class methods of KasPay.
+      # Example usage:
+      #     `about_page = KasPay.about`
       static_pages.each do |page|
          define_method(page) do
+            # Watir::Browser object is created when it's not exist.
             browse BASE_URL if (defined?(@@browser)).nil?
             @@browser.goto "#{BASE_URL}/#{page}"
             @@browser.div(id: "body").text
          end
       end
 
+      # Creates Watir::Browser object for navigating web pages.
       def browse url
          @@headless = Headless.new
          @@headless.start
          @@browser = Watir::Browser.start url
       end 
 
+      # Creates an alias for `KasPay.term` method, which is 
+      # `KasPay.terms`
       alias_method :terms, :term
+
+      # Changes class method `new` to `login` (the more natural
+      # name) to make an instance of KasPay.
       alias_method :login, :new
+      # Hidden to force the use of `login` as the class method
+      # for instantiation.
       private :new
    end
-
-   BASE_URL = "https://www.kaspay.com"
-   LOGIN_URL = BASE_URL + "/login" 
-   THINGS_TO_GET = %w(name balance acc_num).map(&:to_sym)
-   THE_GET_METHODS = add__get__to(THINGS_TO_GET)
    
+   # Creates browser and headless methods for browsing without
+   # a visible browser or 'head', and email and password methods
+   # for reading @email and @password instance variables.
    attr_accessor :browser
    attr_accessor :headless
    attr_reader :email
    attr_reader :password
+  
+   # Some methods need to be inaccessible
    private :headless
    private :headless=
    private :password
 
-   def initialize user = { email: "", password: "" }
-      unless user[:email] == "" || user[:password] == ""
+   # Accept a hash argument from class methods `login`
+   def initialize user = { email: nil, password: nil }
+      unless user[:email] == nil || user[:password] == nil
          @email = user[:email]
          @password = user[:password]
          login 
       end
    end
    
+   # Actually starts the login process after email and password
+   # provided. This is actualy different from the class method
+   # `login` that only creates KasPay object and compounding the
+   # data for login. 
    def login 
       headless = Headless.new
       headless.start
@@ -61,16 +97,18 @@ class KasPay
       browser.button(name: 'button').click
    end
 
+   # Sets email input
    def email= mail
       @email = mail
       login if user_data_complete?
    end
 
+   # Sets password input
    def password= pass 
       @password = pass
       login if user_data_complete?
    end
-
+   
    def current_url
       browser.url
    end
@@ -111,9 +149,26 @@ class KasPay
    end
 
    def user_data_complete?
-      email != "" && password != "" 
+      !email.nil? && !password.nil? 
    end
 
+   def save_login login_name
+      Dir.mkdir(DATA_DIR) unless Dir.exists?(DATA_DIR)
+      kasdb = PStore.new(DATA_PATH)
+      kasdb.transaction do
+         kasdb[login_name] = {email: email, password: password}
+      end
+   end
+
+   def load_login login_name
+      kasdb = PStore.new(DATA_PATH)
+      kasdb.transaction do
+         @email = kasdb[login_name][:email]
+         @password = kasdb[login_name][:password]
+         return kasdb[login_name]
+      end
+   end
+ 
    def inspect
       "#<#{self.class}:0x#{(object_id << 1).to_s(16)} logged_in=#{logged_in?}>"
    end
@@ -122,7 +177,7 @@ class KasPay
       if THINGS_TO_GET.include? m
          send("get_#{m}")
       else
-         raise NoMethodError, "undefined method `#{m}' for #{self}"
+         super
       end 
    end 
    
@@ -137,6 +192,16 @@ class KasPay
    
 private
 
+   def login_data_exists?
+      data = nil
+      begin
+         PStore.new("kaspay.dat").tap{|x| x.transaction{ data = x.roots}}
+         return (data != [])
+      rescue NameError
+         return false
+      end
+   end
+  
    def logout_link
       logout_link = browser.a(href: "https://www.kaspay.com/account/logout")
    end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kaspay
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Adrian Setyadi