bizhub-tool 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= BizhubTool
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BizhubTool'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/bizhub-tool.rb

@@ -0,0 +1,4 @@
+require "bizhub-tool/client"
+
+module BizhubTool
+end

data/lib/bizhub-tool/client.rb

@@ -0,0 +1,218 @@
+require 'net/http'
+
+module BizhubTool    
+    class Client
+      
+    attr_accessor :auth_key, :url, :username, :password, :lock_key
+
+    def initialize(url, username, password)
+      self.url = URI.parse(url)
+      self.username = username
+      self.password = password
+      if self.confirm_connect
+        if self.login
+          true
+        else
+          raise ArgumentError, "user/name password invalid"
+        end
+      else
+        raise ArgumentError, "unable to connect"
+      end
+    end
+  
+    def confirm_connect
+      # url = URI.parse('http://geoffrey.synapsedev.com:50001/')
+      request = Net::HTTP::Post.new(self.url.path)
+      body =<<-TEXT
+      <AppReqConfirmConnect xmlns="http://www.konicaminolta.com/service/OpenAPI-4-2"><OperatorInfo><UserType>#{self.username}</UserType><Password>#{self.password}</Password></OperatorInfo></AppReqConfirmConnect>
+      TEXT
+      request.body = self.class.generate_request(body)
+      response = Net::HTTP.start(url.host, url.port) {|http| http.request(request)}
+      response.body
+      response_hash = Nori.parse(response.body)
+      request_hash = Nori.parse(request.body)
+      puts response_hash
+      log_response(response_hash, request.body, "app_res_confirm_connect", __method__)
+    end
+
+    def login
+      request = Net::HTTP::Post.new(self.url.path)
+      body =<<-TEXT
+      <AppReqLogin xmlns="http://www.konicaminolta.com/service/OpenAPI-4-2"><OperatorInfo><UserType>#{self.username}</UserType><Password>#{self.password}</Password></OperatorInfo><TimeOut>60</TimeOut></AppReqLogin>
+      TEXT
+      request.body = self.class.generate_request(body)
+      puts request.body
+      response = Net::HTTP.start(url.host, url.port) {|http| http.request(request)}
+      response.body
+      response_hash = Nori.parse(response.body)
+      if log_response(response_hash, request.body, "app_res_login", __method__)
+        self.auth_key = response_hash[:envelope][:body][:app_res_login][:auth_key]
+        true
+      else
+        false
+      end
+    end
+
+
+    def enter_device_lock
+      request = Net::HTTP::Post.new(self.url.path)
+      body =<<-TEXT
+      <AppReqEnterDeviceLock xmlns="http://www.konicaminolta.com/service/OpenAPI-4-2"><OperatorInfo><AuthKey>#{self.auth_key}</AuthKey></OperatorInfo><LockType>DownloadLock</LockType><PackageEntryFlg>Package</PackageEntryFlg><TimeOut>60</TimeOut></AppReqEnterDeviceLock>
+      TEXT
+      request.body = self.class.generate_request(body)
+      response = Net::HTTP.start(url.host, url.port) {|http| http.request(request)}
+      response.body
+      response_hash = Nori.parse(response.body)
+      if log_response(response_hash, request.body, "app_res_enter_device_lock", __method__)
+        self.lock_key = response_hash[:envelope][:body][:app_res_enter_device_lock][:lock_key]
+        true
+      else
+        false
+      end
+    end
+
+    def exit_device_lock
+      request = Net::HTTP::Post.new(self.url.path)
+      body =<<-TEXT
+      <AppReqExitDeviceLock xmlns="http://www.konicaminolta.com/service/OpenAPI-4-2"><OperatorInfo><AuthKey>#{self.auth_key}</AuthKey></OperatorInfo><LockKey>#{self.lock_key}</LockKey></AppReqExitDeviceLock>
+      TEXT
+      request.body = self.class.generate_request(body)
+      response = Net::HTTP.start(url.host, url.port) {|http| http.request(request)}
+      response_hash = Nori.parse(response.body)
+      log_response(response_hash, request.body, "app_res_exit_device_lock", __method__)
+    end
+
+    def set_abbr(first_name, last_name, email, abbr_no)
+      search_key = self.class.find_search_key(last_name)
+      full_name = [first_name, last_name].join(" ")
+      request = Net::HTTP::Post.new(self.url.path)
+      body =<<-TEXT
+      <AppReqSetAbbr xmlns="http://www.konicaminolta.com/service/OpenAPI-4-2"><OperatorInfo><AuthKey>#{self.auth_key}</AuthKey></OperatorInfo><CreateCondition><Auto>false</Auto><OverWrite>true</OverWrite></CreateCondition><LockKey>#{self.lock_key}</LockKey><Abbr xmlns:m="http://www.konicaminolta.com/service/OpenAPI-4-2"><AbbrNo>#{abbr_no}</AbbrNo><Name>#{full_name}</Name><SearchKey>#{search_key}</SearchKey><WellUse>false</WellUse><SendConfiguration><SendGroup>Scan</SendGroup><TargetAddressType>Single</TargetAddressType><AddressInfo><SendMode>Email</SendMode><EmailMode><To>#{email}</To></EmailMode><ImageType>Icon</ImageType><IconID>1</IconID><PhotoEditFlag>NotRegistered</PhotoEditFlag></AddressInfo></SendConfiguration><FaxConfiguration /><EditFlag>Appended</EditFlag><ReferLicence><UseReferLicence>Level</UseReferLicence><ReferGroupNo>1</ReferGroupNo><ReferPossibleLevel>0</ReferPossibleLevel></ReferLicence><AddressKind>Public</AddressKind></Abbr></AppReqSetAbbr>
+      TEXT
+      request.body = self.class.generate_request(body)
+      response = Net::HTTP.start(url.host, url.port) {|http| http.request(request)}
+      response_hash = Nori.parse(response.body)
+      log_response(response_hash, request.body, "app_res_set_abbr", __method__)
+    end
+
+    def get_abbr(start, length)
+      request = Net::HTTP::Post.new(self.url.path)
+      body =<<-TEXT
+      <AppReqGetAbbr xmlns="http://www.konicaminolta.com/service/OpenAPI-4-2"><OperatorInfo><AuthKey>#{self.auth_key}</AuthKey></OperatorInfo><AbbrListCondition><SearchKey>None</SearchKey><WellUse>false</WellUse><ObtainCondition><Type>OffsetList</Type><OffsetRange><Start>#{start}</Start><Length>#{length}</Length></OffsetRange></ObtainCondition><BackUp>true</BackUp><BackUpPassword>MYSKIMGS</BackUpPassword></AbbrListCondition></AppReqGetAbbr>
+      TEXT
+      request.body = self.class.generate_request(body)
+      response = Net::HTTP.start(url.host, url.port) {|http| http.request(request)}
+      response_hash = Nori.parse(response.body)
+      if log_response(response_hash, request.body, "app_res_get_abbr", __method__)
+        response_hash
+      else
+        false
+      end
+    end
+
+    def delete_abbr(abbr_no)
+      request = Net::HTTP::Post.new(self.url.path)
+      body =<<-TEXT
+      <AppReqDeleteAbbr xmlns="http://www.konicaminolta.com/service/OpenAPI-4-2"><OperatorInfo><AuthKey>#{self.auth_key}</AuthKey></OperatorInfo><LockKey>#{self.lock_key}</LockKey><AllItem>false</AllItem><AddressKind>Public</AddressKind><AbbrNo>#{abbr_no}</AbbrNo></AppReqDeleteAbbr>
+      TEXT
+      request.body = self.class.generate_request(body)
+      response = Net::HTTP.start(url.host, url.port) {|http| http.request(request)}
+      response_hash = Nori.parse(response.body)
+      log_response(response_hash, request.body, "app_res_delete_abbr", __method__)
+    end
+
+    def get_max_abbr
+      array_size = 100
+      start_value = 1
+      results = true
+  
+      while results == true
+        puts start_value
+        response = self.get_abbr(start_value, array_size)
+        if response[:envelope][:body][:app_res_get_abbr][:abbr_list][:array_size].to_i == array_size
+          start_value += array_size
+        else
+          results = false
+          max_abbr = response[:envelope][:body][:app_res_get_abbr][:abbr_list][:abbr].last[:abbr_no]
+        end
+      end
+      max_abbr
+    end
+
+    private
+
+    def self.find_search_key(string)
+      search_keys = ['Abc', 'Def', 'Ghi', 'Jkl', 'Mno', 'Pqrs', 'Tuv', 'Wxyz']
+      search_key = nil
+  
+      search_keys.each do |k|
+        if k.downcase.scan(string[0,1].downcase).count > 0
+          search_key = k
+        end
+      end
+  
+      if search_key
+        search_key
+      else
+        raise ArgumentError, "unable to get a search key"
+      end
+    end
+
+    def self.determine_status(response_hash, method)
+      if response_hash[:envelope][:body][method.to_sym][:result][:result_info] == 'Ack'
+        'SUCCESS'
+      elsif response_hash[:envelope][:body][method.to_sym][:result][:result_info] == 'Nack'
+        'NO SUCCESS'
+      end
+    end
+
+    def self.generate_request(body)
+      request =<<-TEXT 
+      <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><SOAP-ENV:Header><me:AppReqHeader xmlns:me="http://www.konicaminolta.com/Header/OpenAPI-4-2"><ApplicationID xmlns="">0</ApplicationID><UserName xmlns=""></UserName><Password xmlns=""></Password><Version xmlns=""><Major>4</Major><Minor>2</Minor></Version><AppManagementID xmlns="">1000</AppManagementID></me:AppReqHeader></SOAP-ENV:Header><SOAP-ENV:Body>
+      TEXT
+      request += body
+      request += "</SOAP-ENV:Body></SOAP-ENV:Envelope>"
+      request
+    end
+
+    def self.log_debug(url, action, status, request, response)
+      RedisLogger.debug({ 
+       "url" => url,
+       "class::method" => action,
+       "status" => status,
+       "request" => request,
+       "response" => response
+      }, ['bizhub'])
+    end
+
+    def self.log_error(url, action, status, request, response)
+      RedisLogger.error({ 
+       "url" => url,
+       "class::method" => action,
+       "status" => status,
+       "request" => request,
+       "response" => response
+      }, ['bizhub'])
+    end
+
+    def log_response(response_hash, request, api_method, class_method)
+      if response_hash[:envelope][:body][:fault]
+        self.class.log_error(self.url, get_class_method(class_method), 'ERROR', 
+          Nori.parse(request), response_hash
+        )
+        false
+      else
+        self.class.log_debug(self.url, get_class_method(class_method), 
+          self.class.determine_status(response_hash, api_method), 
+          Nori.parse(request), response_hash
+        )
+        true
+      end
+    end
+
+    def get_class_method(method)
+      self.class.name + '::' + method.to_s
+    end  
+  end
+
+end

data/lib/bizhub-tool/version.rb

@@ -0,0 +1,3 @@
+module BizhubTool
+  VERSION = "0.0.2"
+end

data/lib/tasks/bizhub-tool_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bizhub-tool do
+#   # Task goes here
+# end

data/test/bizhub-tool_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BizhubToolTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, BizhubTool
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.