doxieland 0.1.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 844c42e8cbc32d2537f7b4e0802f7504882f95a6
-  data.tar.gz: 8ed0de9163005a259fa3f5c127f76e41f17a6402
+  metadata.gz: 3a8265c8aef3acb73110d4c084c45ee809391bb6
+  data.tar.gz: a6636e435c48b7a47fc0035a3d08635083b44c9c
 SHA512:
-  metadata.gz: e2e25efc0b3df591063ef6b390b333cdc3530c5fa8d6388b37616223bfd0ea604b5f247a7aabf29fa7b8291a8e2e03c54583c05675f947f22f39ccaeec745f87
-  data.tar.gz: c5b9a1490234bfa2ba1b6ad47e0bb27eeace7431ca159d550c40597bcf3c8aacbb7c9f3e5e4990ed08e9119ddf534727cb52bea8ec6771b880b1e36cb4709380
+  metadata.gz: bbc20ab3361ffadbc3d710b9a8c4e8d384470de16d3b86c6db1926d6542dc67aa2314e24f78de9c0bf51be927e0c81c332c8087c87089b86029d5f55e54276cf
+  data.tar.gz: f3128eb67754c15858636561f8b1588dd76271ca06414ab0a2a8ef39c03ee00a43a6c5293d4e34d343228666e26e92f813b9a757f2a1502899c6fdc06032f4d0

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+doxieland.sublime-*

data/.ruby-gemset

@@ -0,0 +1 @@
+doxieland

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/doxieland.gemspec

@@ -20,8 +20,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency 'activesupport', '>= 4.2'
-  spec.add_runtime_dependency 'apidiesel', '>= 0.8'
-  spec.add_runtime_dependency 'commander', '>= 4.3'
+  spec.add_runtime_dependency 'apidiesel', '>= 0.12'
+  spec.add_runtime_dependency 'thor', '>= 0.19'
+  spec.add_runtime_dependency 'ruby-progressbar', '>= 1.7'
+  spec.add_runtime_dependency 'hirb', '>= 0.7'
+  spec.add_runtime_dependency 'rainbow', '>= 2.1'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

data/exe/doxieland

@@ -1,23 +1,206 @@
 #!/usr/bin/env ruby
-
 require "doxieland"
-require 'commander/import'
+require "thor"
+require "ruby-progressbar"
+require 'hirb'
+
+class CLI < Thor
+  include Thor::Actions
 
-program :name, 'doxieland'
-program :version, '0.0.1'
-program :description, 'A command line tool for downloading scans from the doxie go wi-fi'
+  class_option 'scanner-ip', desc:'your scanners network address', banner: 'xxx.xxx.xxx.xxx', type: :string, aliases: '-i'
+  class_option :password, desc:'your scanners password', type: :string, aliases: '-p'
 
-global_option('-i', '--scanner-ip=xxx.xxx.xxx.xxx', 'your scanners network address') { |ip| @ip = ip }
+  def initialize(*args, **kargs)
+    super
+
+    @config = (options || HashWithIndifferentAccess.new).reverse_merge(Doxieland.config)
+    @client = Doxieland::Client.new(@config)
+  end
+
+  desc "info", "show information about your scanner"
+  def info
+    response =
+      @client.api do |api|
+        api.get_info.result
+      end
+
+      puts Hirb::Helpers::AutoTable.render(
+          response,
+          description:  false,
+          headers:      false
+        )
+  end
 
-command :list do |c|
-  c.syntax = 'doxieland list'
-  c.description = 'lists all scans saved in your scanners memory'
-  c.action do |args, options|
-    Doxieland::Api.url "http://#{@ip}:8080"
-    api = Doxieland::Api.new
+  desc "list", "list all scans saved in your scanners memory"
+  def list
+    scans = @client.api { |api| api.list_scans.result }
 
-    api.list_scans.result.each do |scan|
-      puts scan[:name]
+    if scans.none?
+      log.info "no scans found"
+      exit
     end
+
+    puts Hirb::Helpers::AutoTable.render(
+      scans,
+      fields: [:name, :path],
+      description: false
+    )
+
+    log.info "#{scans.length} scans available"
   end
-end
+
+  desc "download", <<-EOT.strip_heredoc
+    download all scans from your scanner to your computer
+
+    Available placeholders for filename format strings:
+      %{number} - the image number
+      %{date} - the current date as DD.MM.YYYY
+      %{time} - the current time as HH:MM:SS
+
+    You can further format date and time by passing format options inside the placeholders, separated by a colon:
+
+      %{date:%Y-%m-%d}
+
+    See http://ruby-doc.org/core-2.2.0/Time.html#method-i-strftime for all available date and time formatting options.
+
+  EOT
+  method_option :to, desc: "the directory to save the scans to. Defaults to .", type: :string, aliases: '-t'
+  method_option :filenames,
+                type: :string,
+                aliases: '-f',
+                banner: '"FORMAT_STRING"',
+                desc: 'filename format string. Default: "doxie_scan_%{date}-%{number}"'
+  method_option :pdf, desc: "convert scans to PDF. Requires ImageMagick to be installed", type: :boolean
+  method_option :delete, desc: "delete scans from scanner after download", type: :boolean, aliases: '-d'
+  def download
+    if @config[:pdf]
+      unless command_available?('convert')
+        log.fatal "could not find the 'convert' command. PDF conversion requires ImageMagick to be installed"
+        exit(false)
+      end
+    end
+
+    @client.create_save_path
+
+    Doxieland::Scan.save_path   = @client.save_path
+    Doxieland::Scan.name_format = @config[:filenames] if @config[:filenames]
+
+    scans = @client.api do |api|
+      api.list_scans.result
+    end
+
+    if scans.none?
+      log.info "0 scans available for download on scanner"
+      exit
+    end
+
+    log.info "downloading #{scans.length} scans to " + Rainbow(@client.save_path).cyan.bright
+
+    progressbar = create_progressbar(starting_at: 0, total: scans.length)
+
+    deletable_paths = []
+    save_count      = 0
+
+    scans.each do |remote_scan|
+      progressbar.title = "downloading #{remote_scan[:name]}".truncate(22).ljust(25)
+
+      scan = @client.api { |api| api.get_scan(path: remote_scan[:path]).result }
+
+      if @config[:pdf]
+        scan.file_type = 'pdf'
+        progressbar.title = "saving #{remote_scan[:name]} as PDF".truncate(22).ljust(25)
+      else
+        progressbar.title = "saving #{remote_scan[:name]}".truncate(22).ljust(25)
+      end
+
+      if scan.save
+        save_count += 1
+        deletable_paths << remote_scan[:delete_path]
+      else
+        log.progress_warn "skipped existing file #{scan.path}", progressbar
+      end
+
+      progressbar.increment
+    end
+
+    if options[:delete] && deletable_paths.any?
+      progressbar = create_progressbar(title: "deleting scans".ljust(20))
+
+      @client.api { |api| api.delete_scans(paths: deletable_paths).result }
+
+      progressbar.progress = 1
+      progressbar.total    = 1
+      progressbar.finish
+    end
+
+    log.success "#{save_count} scans downloaded"
+  end
+
+  desc "defaults", "show or set default options for doxieland"
+  method_option :to, desc: "the directory to save the scans to. Defaults to .", type: :string, aliases: '-t'
+  method_option :filenames,
+                type: :string,
+                aliases: '-f',
+                banner: '"FORMAT_STRING"'
+  method_option :pdf, desc: "convert scans to PDF. Requires ImageMagick to be installed", type: :boolean
+  method_option :delete, desc: "delete scans from scanner after download", type: :boolean, aliases: '-d'
+  def defaults
+    if options.none?
+      config = Doxieland.config
+
+      if config.any?
+        puts Hirb::Helpers::AutoTable.render(
+          config,
+          description:  false,
+          headers:      { 0 => 'option', 1 => 'value' }
+        )
+      else
+        log.info "no defaults set"
+      end
+
+    else
+      File.open(Doxieland.config_path, 'w') { |file| file << YAML.dump(options) }
+
+      puts Hirb::Helpers::AutoTable.render(
+        config,
+        description:  false,
+        headers:      { 0 => 'option', 1 => 'value' }
+      )
+
+      log.success "new default settings saved"
+    end
+  end
+
+  desc "console", "starts a Pry REPL session", hide: true
+  def console
+    begin
+      require 'pry'
+    rescue LoadError
+      log.fatal "doxieland console requires Pry to be installed: gem install pry"
+      exit
+    end
+    binding.pry
+  end
+
+  no_commands do
+    def log
+      @client.log
+    end
+
+    def create_progressbar(**kargs)
+      kargs.reverse_merge!({
+        total: nil,
+        format: "%t (%c of %C) |%b\u{1F431}%i| %E",
+        progress_mark: "\u{2728}",
+        remainder_mark: " ", title: ' ' * 25
+      })
+      ProgressBar.create(**kargs)
+    end
+
+    def command_available?(command)
+      `which #{command}`.present? && $?.exitstatus == 0
+    end
+  end
+end
+
+CLI.start( ARGV.any? ? ARGV : ['help'] )

data/lib/doxieland.rb

@@ -2,11 +2,35 @@ require "doxieland/version"
 
 require 'active_support/all'
 require 'apidiesel'
+require 'rainbow'
+require 'open-uri'
+require 'cgi'
+require 'pathname'
+require 'fileutils'
+require 'open3'
 
-require 'doxieland/handlers/json'
+require 'doxieland/handlers/file_request'
 require 'doxieland/actions/list_scans'
+require 'doxieland/actions/get_info'
+require 'doxieland/actions/get_scan'
+require 'doxieland/actions/delete_scans'
 require 'doxieland/api'
+require 'doxieland/scan'
+require 'doxieland/logger'
+require 'doxieland/client'
 
 module Doxieland
-  # Your code goes here...
+  class AuthenticationError < StandardError; end
+
+  def self.config_path
+    Pathname.new('~/.doxieland').expand_path
+  end
+
+  def self.config
+    if File.file?(config_path)
+      YAML.load( File.read(config_path) ).with_indifferent_access
+    else
+      HashWithIndifferentAccess.new
+    end
+  end
 end

data/lib/doxieland/actions/delete_scans.rb

@@ -0,0 +1,17 @@
+module Doxieland
+  module Actions
+    class DeleteScans < ::Apidiesel::Action
+      url path: '/scans/delete.json'
+
+      http_method :post
+
+      expects do
+        object :paths, klass: Array
+      end
+
+      format_parameters do |params|
+        params[:paths]
+      end
+    end
+  end
+end

data/lib/doxieland/actions/get_info.rb

@@ -0,0 +1,8 @@
+module Doxieland
+  module Actions
+    class GetInfo < ::Apidiesel::Action
+      http_method :get
+      url path: '/hello.json'
+    end
+  end
+end

data/lib/doxieland/actions/get_scan.rb

@@ -0,0 +1,20 @@
+module Doxieland
+  module Actions
+    class GetScan < ::Apidiesel::Action
+      use Apidiesel::Handlers::ActionResponseProcessor
+      use Handlers::FileRequest
+
+      url ->(base_url, request) {
+        base_url.path = request.parameters.delete(:path)
+
+        base_url
+      }
+
+      http_method :get
+
+      expects do
+        string :path
+      end
+    end
+  end
+end

data/lib/doxieland/actions/list_scans.rb

@@ -3,6 +3,22 @@ module Doxieland
     class ListScans < ::Apidiesel::Action
       http_method :get
       url path: '/scans.json'
+
+      responds_with do
+        array do
+          string :path,
+                  at: :name,
+                  filter: ->(s) { "/scans#{s}" }
+          string :delete_path,
+                  at: :name
+          string :thumbnail_path,
+                  at: :name,
+                  filter: ->(s) { "/thumbnails#{s}" }
+          string :name,
+                  filter: ->(s) { s.match(/[0-9]{4,}/)[0] }
+          integer :size
+        end
+      end
     end
   end
 end

data/lib/doxieland/api.rb

@@ -1,8 +1,10 @@
 module Doxieland
   class Api < Apidiesel::Api
-    use Handlers::JSON
+    use Apidiesel::Handlers::JSON
 
     config :timeout, 4000
+    config :username, 'doxie'
+    config :password, nil
 
     register_actions
   end

data/lib/doxieland/client.rb

@@ -0,0 +1,94 @@
+module Doxieland
+  class Client
+    attr_reader :save_path
+
+    def initialize(options)
+      @options       = options
+      @save_path     = Pathname.new(options[:to] || '.').expand_path
+    end
+
+    def api(&block)
+      Doxieland::Api.url "http://#{scanner_ip}:8080"
+
+      if @options[:password]
+        Doxieland::Api.http_basic_auth 'doxie', @options[:password]
+      end
+
+      api = Doxieland::Api.new
+
+      begin
+        yield api
+      rescue AuthenticationError => e
+        log.fatal e.message
+        exit(false)
+      end
+    end
+
+    def create_save_path
+      raise ArgumentError, "#{@save_path} is a file" if @save_path.file?
+
+      unless @save_path.directory? || @save_path == Pathname.new('.')
+        FileUtils.mkdir_p(@save_path)
+      end
+    end
+
+    def loglevel
+      @options[:verbose] ? :debug : :info
+    end
+
+    def log
+      @logger ||= Logger.new(loglevel)
+    end
+
+    def scanner_ip
+      @scanner_ip ||= begin
+        if @options['scanner-ip']
+          @options['scanner-ip']
+        elsif @options[:ap]
+          '192.168.1.100'
+        else
+          discovered_ip = ssdp_discover
+
+          unless discovered_ip
+            log.fatal "… sorry, your scanner could not be found. Is WiFi turned on and the status light blue?"
+            log.info "If you know it, you can also provide the IP address manually via the --scanner-ip flag."
+            exit
+          end
+
+          discovered_ip
+        end
+      end
+    end
+
+    def ssdp_discover
+      socket = UDPSocket.new
+      socket.setsockopt Socket::SOL_SOCKET, Socket::SO_BROADCAST, true
+      socket.setsockopt :IPPROTO_IP, :IP_MULTICAST_TTL, 1
+
+      query = [
+        'M-SEARCH * HTTP/1.1',
+        'HOST: 239.255.255.250:1900',
+        'MAN: "ssdp:discover"',
+        'ST: urn:schemas-getdoxie-com:device:Scanner:1',
+        # 'ST: ssdp:all',
+        'MX: 3',
+        '',
+        ''
+      ].join("\r\n")
+
+      log.info "trying to find your scanner on the network. Here, Doxie Doxie…"
+
+      socket.send(query, 0, '239.255.255.250', 1900)
+
+      ready = IO.select([socket], nil, nil, 10)
+
+      if ready
+        _, message_sender = socket.recvfrom(65507)
+
+        log.success "found the little rascal hiding at #{message_sender.last}"
+
+        message_sender.last
+      end
+    end
+  end
+end