amazon_auth 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5372326bf8eb4d5ad7208f1012fb3637f0d75bfb
-  data.tar.gz: 1318f2610357e659f04a3054c62b6ff1da7aa9e7
+  metadata.gz: 54054238c0843dbd6acc152aa7cd42186645b564
+  data.tar.gz: 80d121226920bde30c3493d90e33bf9819bf2adb
 SHA512:
-  metadata.gz: 2faa1765823348febcb15dca571b5849a8ac5fd9454f8e944cccbd4290354acb11d0f90b1dd782fffaefc553cd5f39a118cde44b4ceab6e972ade7b5ac0d06bf
-  data.tar.gz: dd44a0edf4af32714802cd63d2f6c222993661114025b4bd3972e108855dc87f1c26cfa55dcece5e46dc58252215c1be3d84d5c5b53786ddb3aaf3502c20d357
+  metadata.gz: 2761572472a93eb91acb879cb19f7614ba0b393671c7de020552386319ef606e1dc8abac78c40c5ba33d8fe120e96bf4327a2f670c8b577af06645f9744e8f7b
+  data.tar.gz: 68d334892df7fe5a338df6772fec708fff3f634581e561412322c39a529b9be4e842e4370cf28e2b67e5556c14b781b532a1c63308cc2f57f35935550ab3e58a

data/README.md

@@ -6,6 +6,7 @@
 Sign In Amazon using Capybara and Selenium
 
 ![amazon_auth_login](https://cloud.githubusercontent.com/assets/275284/25064724/7f5faae4-223b-11e7-9fc6-4a82d1d727ab.gif)
+
 Recorded with [Recordit](http://recordit.co/)
 
 ## Installation
@@ -48,6 +49,22 @@ Run `amazon_auth` and paste the output to _.env_.
 
 ![amazon_auth_setup](https://cloud.githubusercontent.com/assets/275284/25064607/9b9b80be-2238-11e7-95fc-c1547a83f178.gif)
 
+### envchain for security
+
+You can store environment variables in macOS Keychain instead of dotenv.
+Check out [envchain](https://github.com/sorah/envchain)
+
+```
+brew install envchain
+
+envchain --set amazon AMAZON_DOMAIN AMAZON_USERNAME_CODE AMAZON_PASSWORD_CODE AMAZON_CODE_SALT
+
+# Run console with envchain
+envchain amazon bin/console
+envchain amazon bundle exec irb
+envchain amazon rails console
+```
+
 ### Run
 
 In console, you can move around pages using Capybara DSL
@@ -73,6 +90,20 @@ Set `AMAZON_DOMAIN` in _.env_.
 
 e.g. `AMAZON_DOMAIN=amazon.co.jp` for Japanese site
 
+### Keep cookies
+
+Using [capybara-sessionkeeper gem](https://github.com/kyamaguchi/capybara-sessionkeeper)
+
+```
+client = AmazonAuth::Client.new(keep_cookie: true, debug: true)
+```
+
+You can change Capyabra.save_path when it isn't set
+
+```
+client = AmazonAuth::Client.new(keep_cookie: true, save_path: 'tmp/cookies', debug: true)
+```
+
 ### Logging
 
 Normal logging
@@ -110,6 +141,10 @@ In console,
 client = AmazonAuth::Client.new(driver: :firefox)
 ```
 
+## TODO
+
+- [Idea] Hook `submit_signin_form` after every `visit` and `click` action
+
 ## Development
 
 Use _.env.development_ instead of _.env_ in development.

data/amazon_auth.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'capybara'
+  spec.add_runtime_dependency 'capybara-sessionkeeper', "~> 0.1.1"
   spec.add_runtime_dependency 'selenium-webdriver'
   spec.add_runtime_dependency 'highline'
   spec.add_runtime_dependency 'dotenv'

data/lib/amazon_auth.rb

@@ -2,6 +2,7 @@ require 'dotenv'
 Dotenv.load
 require "active_support/all"
 require "capybara"
+require "capybara/sessionkeeper"
 require "highline/import"
 begin
   require 'byebug'

data/lib/amazon_auth/client.rb

@@ -3,86 +3,23 @@ module AmazonAuth
     include AmazonAuth::CommonExtension
     include AmazonAuth::SessionExtension
 
-    attr_accessor :initial_url
+    attr_accessor :options
 
     def initialize(options = {})
       @options = options
-      @initial_url = options.fetch(:url) { "https://www.#{AmazonInfo.domain}/" }
-      @login = options.fetch(:login) do
-        if (amazon_username_code = ENV['AMAZON_USERNAME_CODE']).present?
-          Converter.decode(amazon_username_code)
-        else
-          raise('AMAZON_USERNAME_CODE is required.')
-        end
-      end
-      @password = options.fetch(:password) do
-        if (amazon_password_code = ENV['AMAZON_PASSWORD_CODE']).present?
-          Converter.decode(amazon_password_code)
-        else
-          raise('AMAZON_PASSWORD_CODE is required.')
-        end
-      end
       @driver = options.fetch(:driver, :selenium)
+      # Check credentials
+      raise('AMAZON_USERNAME_CODE is required.') unless (options[:login] || ENV['AMAZON_USERNAME_CODE']).present?
+      raise('AMAZON_PASSWORD_CODE is required.') unless (options[:password] || ENV['AMAZON_PASSWORD_CODE']).present?
+      Converter.salt if options[:login].blank? || options[:password].blank?
 
-      Capybara.app_host = @initial_url
+      Capybara.save_path = options.fetch(:save_path, 'tmp') if Capybara.save_path.nil?
+      Capybara.app_host = initial_url if Capybara.app_host.nil?
     rescue => e
       puts "Please setup credentials of amazon_auth gem with folloing its instruction."
       raise e
     end
 
-    def sign_in
-      session.visit initial_url
-      debug "Visiting #{initial_url}"
-      link = links_for('#nav-signin-tooltip a').find{|link| link =~ %r{\A/gp/navigation/redirector.html} }
-      debug "link: [#{link}]"
-      session.visit(link) if link
-      submit_signin_form
-    end
-
-    def submit_signin_form
-      debug "Begin submit_signin_form"
-      unless session.has_selector?('#signInSubmit')
-        log "signInSubmit button not found"
-        return false
-      end
-      session.fill_in 'ap_email', with: @login if session.first('#ap_email').value.blank?
-      session.fill_in 'ap_password', with: @password
-      session.first('#signInSubmit').click
-      log "Clicked signInSubmit"
-
-      raise('Failed on signin') if alert_displayed?
-      while image_recognition_displayed? do
-        retry_signin_form_with_image_recognition
-      end
-      debug "End submit_signin_form"
-      true
-    end
-
-    def retry_signin_form_with_image_recognition
-      return true unless session.has_selector?('#signInSubmit')
-      session.fill_in 'ap_password', with: @password
-      if image_recognition_displayed?
-        input = ask "Got the prompt. Read characters from the image [blank to cancel]: "
-        if input.blank?
-          debug "Going back to #{initial_url}"
-          session.visit initial_url
-          return true
-        end
-        session.fill_in 'auth-captcha-guess', with: input
-      end
-      sleep 1
-      session.click_on('signInSubmit')
-      sleep 2
-    end
-
-    def alert_displayed?
-      session.has_selector?('.a-alert-error')
-    end
-
-    def image_recognition_displayed?
-      session.has_selector?('#auth-captcha-image-container')
-    end
-
     def session
       @session ||= Capybara::Session.new(@driver)
     end

data/lib/amazon_auth/extensions/common_extension.rb

@@ -4,7 +4,7 @@ module AmazonAuth
     def log(message)
       return unless (@options[:debug] || @options[:verbose])
       puts "[#{Time.current.strftime('%Y-%m-%d %H:%M:%S')}] #{message}" +
-        (@options[:debug] && session ? " -- #{session.current_url}" : '')
+        (@options[:debug] && @session ? " -- #{session.current_url}" : '')
     end
 
     def debug(message)

data/lib/amazon_auth/extensions/session_extension.rb

@@ -19,5 +19,88 @@ module AmazonAuth
         end
       end
     end
+
+    # Helpers for sign in
+    def initial_url
+      options.fetch(:url) { "https://www.#{AmazonInfo.domain}/" }
+    end
+
+    def sign_in(url = nil)
+      url ||= initial_url
+      session.visit url
+      debug "Visiting #{url}"
+      restore_cookies if keep_cookie?
+      if (link = links_for('a').find{|link| link =~ %r{\A/gp/navigation/redirector.html} })
+        debug "link: [#{link}]"
+        session.visit(link)
+      end
+      submit_signin_form
+    end
+
+    def restore_cookies
+      log "Restoring cookies"
+      wait_for_selector('body')
+      session.restore_cookies
+      session.visit session.current_url
+      session.save_cookies
+    end
+
+    def keep_cookie?
+      options[:keep_cookie]
+    end
+
+    def submit_signin_form
+      debug "Begin submit_signin_form"
+      unless session.has_selector?('#signInSubmit')
+        log "signInSubmit button not found in this page"
+        return false
+      end
+      session.fill_in 'ap_email', with: login if session.first('#ap_email').value.blank?
+      session.fill_in 'ap_password', with: password
+      session.first('#signInSubmit').click
+      log "Clicked signInSubmit"
+
+      raise('Failed on signin') if alert_displayed?
+      while image_recognition_displayed? do
+        retry_signin_form_with_image_recognition
+      end
+      debug "End submit_signin_form"
+      session.save_cookies if keep_cookie?
+      true
+    end
+
+    def retry_signin_form_with_image_recognition
+      return true unless session.has_selector?('#signInSubmit')
+      session.fill_in 'ap_password', with: password
+      if image_recognition_displayed?
+        input = ask "Got the prompt. Read characters from the image [blank to cancel]: "
+        if input.blank?
+          debug "Going back to #{initial_url}"
+          session.visit initial_url
+          return true
+        end
+        session.fill_in 'auth-captcha-guess', with: input
+      end
+      sleep 1
+      session.click_on('signInSubmit')
+      sleep 2
+    end
+
+    def alert_displayed?
+      session.has_selector?('.a-alert-error')
+    end
+
+    def image_recognition_displayed?
+      session.has_selector?('#auth-captcha-image-container')
+    end
+
+    private
+
+      def login
+        options.fetch(:login, Converter.decode(ENV['AMAZON_USERNAME_CODE']))
+      end
+      def password
+        options.fetch(:password, Converter.decode(ENV['AMAZON_PASSWORD_CODE']))
+      end
   end
 end

data/lib/amazon_auth/version.rb

@@ -1,3 +1,3 @@
 module AmazonAuth
-  VERSION = "0.3.3"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amazon_auth
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Kazuho Yamaguchi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-04 00:00:00.000000000 Z
+date: 2017-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara-sessionkeeper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement