ruby-spimaging 1.0.0

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-spimaging.gemspec
+gemspec
+
+gem 'rspec'
+gem 'rack'
+gem 'thin'
+gem 'uuid'
+
+gem 'net-ssh'
+gem 'net-scp'
+gem 'highline'
+# gem 'ruby-debug-base'
+# gem 'ruby-debug-ide'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Anthony Marendy
+
+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,29 @@
+# Ruby::Spimaging
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-spimaging'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-spimaging
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

@@ -0,0 +1,26 @@
+require "bundler/gem_tasks"
+require 'net/ssh'
+require 'net/ssh/authentication/methods/password'
+require 'net/scp'
+require 'highline/import'
+
+task :push => :build do
+  def upload(ssh)
+    filename = "spimaging-#{SPImaging::VERSION}.gem"
+    print "Uploading #{filename}..."
+    u = ssh.scp.upload("pkg/#{filename}", "/var/www/rubygems/gems/#{filename}") do
+      print '.'
+    end
+    u.wait
+    puts
+    ssh.exec! '/usr/local/rvm/bin/gem generate_index --directory=/var/www/rubygems'
+  end
+
+  opts = Net::SSH.configuration_for('sp43.sp.local')
+  begin
+    Net::SSH.start('sp43.sp.local', 'rubygems', :auth_methods => %w[publickey]) {|o| upload(o)}
+  rescue
+    password = ask("rubygems@sp43.sp.local's password: ") { |q| q.echo = false }
+    Net::SSH.start('sp43.sp.local', 'rubygems', :password => password) {|o| upload(o)}
+  end
+end

data/lib/spimaging/configuration.rb

@@ -0,0 +1,31 @@
+module SPImaging
+  class Configuration
+    class <<self
+      attr_accessor :configuration_file
+
+      def current
+        env = nil
+        env = Rails.env if defined? Rails
+        env ||= ENV['RAILS_ENV']
+        env ||= ENV['RACK_ENV']
+        raise 'Unable to determine environment' if env.nil?
+
+        c = read
+        raise "Environment not defined in SPImaging configuration: #{env}" if c[env].nil?
+        (c['global'] || {}).merge(c[env])
+      end
+
+      private
+
+      def read
+        if defined? Rails
+          self.configuration_file ||= File.join(Rails.root, 'config', 'spimaging.yml')
+        elsif self.configuration_file.nil?
+          raise 'Unable to determine a default location for SPImaging configuration'
+        end
+
+        @configuration ||= YAML.load_file(self.configuration_file)
+      end
+    end
+  end
+end

data/lib/spimaging/protocol.rb

@@ -0,0 +1,46 @@
+require 'net/http'
+require 'net/https'
+
+module SPImaging
+  class Protocol
+    def self.instance
+      @instance ||= self.new Configuration.current
+    end
+
+    def initialize(config)
+      @base_url = config['base_url']
+      @render_path = config['render_path']
+      @username = config['username']
+      @password = config['password']
+
+      url = URI.parse @base_url
+      @http = Net::HTTP.new url.host, url.port
+      @http.use_ssl = (url.scheme =~ /https/i)
+
+    end
+
+    def download_images(xml)
+      request = Net::HTTP::Post.new URI.join(@base_url, "image/retrieve").to_s
+      request.body = xml
+      request['Accept'] = 'text/html'
+      request['Content-Type'] = 'application/xml'
+      request.basic_auth @username, @password
+
+      response = http.request request
+      raise "Invalid response received: #{response.to_s}" unless response.code == '200'
+
+      SPImaging::ShowImagesResponse.new response.body, response.content_type, response['content-encoding'], response['content-disposition']
+    end
+
+    private
+
+    def http
+      @http.start unless @http.started?
+      @http
+    end
+
+    def render_url
+      URI.join(@base_url, @render_path).to_s
+    end
+  end
+end

data/lib/spimaging/show_images_request.rb

@@ -0,0 +1,35 @@
+require 'nokogiri'
+
+module SPImaging
+  class ShowImagesRequest
+    attr_accessor :uuids, :xml
+
+    def initialize(uuids)
+      self.uuids = uuids
+    end
+
+    def download
+
+      builder = Nokogiri::XML::Builder.new :encoding => 'utf-8' do |xml|
+        # Clients that treat this as a real builder sometimes need to call 'tag!'
+        # That's ok.
+        def xml.tag!(*args, &bl)
+          # Handle reserved names correctly
+          name = args.shift + '_'
+          send name, *args, &bl
+        end
+
+        xml.spimaging do
+          xml.uuids do
+            uuids.each do | uuid |
+              xml.uuid(uuid)
+            end
+          end
+        end
+      end
+
+      @xml = builder.to_xml
+      SPImaging::Protocol.instance.download_images @xml
+    end
+  end
+end

data/lib/spimaging/show_images_response.rb

@@ -0,0 +1,12 @@
+module SPImaging
+  class ShowImagesResponse
+    attr_accessor :body, :content_type, :content_encoding, :content_disposition
+
+    def initialize(body, content_type, content_encoding, content_disposition)
+      self.body = body
+      self.content_type = content_type
+      self.content_encoding = content_encoding
+      self.content_disposition = content_disposition
+    end
+  end
+end

data/lib/spimaging/version.rb

@@ -0,0 +1,4 @@
+module SPImaging
+  # Please use Semantic Versioning - http://semver.org/
+  VERSION = "1.0.0"
+end

data/lib/spimaging.rb

@@ -0,0 +1,9 @@
+require "spimaging/version"
+
+module SPImaging
+  autoload :Configuration, 'spimaging/configuration'
+  autoload :Protocol, 'spimaging/protocol'
+
+  autoload :ShowImagesRequest, 'spimaging/show_images_request'
+  autoload :ShowImagesResponse, 'spimaging/show_images_response'
+end

data/ruby-spimaging.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spimaging/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby-spimaging"
+  spec.version       = SPImaging::VERSION
+  spec.authors       = ["Anthony Marendy"]
+  spec.email         = ["amarendy@sp.com.au"]
+  spec.description   = %q{Interfaces to spimaging}
+  spec.summary       = %q{Downloads a collection of files from spimaging}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency 'nokogiri', "1.5.9"
+end

data/ruby-spimaging.iml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="FacetManager">
+    <facet type="gem" name="Ruby Gem">
+      <configuration>
+        <option name="GEM_APP_ROOT_PATH" value="$MODULE_DIR$" />
+        <option name="GEM_APP_TEST_PATH" value="$MODULE_DIR$/test" />
+        <option name="GEM_APP_LIB_PATH" value="$MODULE_DIR$/lib" />
+      </configuration>
+    </facet>
+  </component>
+  <component name="NewModuleRootManager" inherit-compiler-output="true">
+    <exclude-output />
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.3.5, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="daemons (v1.1.9, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.5, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="eventmachine (v1.0.3, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="highline (v1.6.21, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="macaddr (v1.7.1, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="net-scp (v1.2.1, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="net-ssh (v2.9.1, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="nokogiri (v1.5.9, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rack (v1.5.2, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v10.1.0, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.1.0, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.1.7, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.1.2, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.1.3, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.1.2, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="systemu (v2.6.4, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="thin (v1.6.3, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="uuid (v2.3.7, RVM: ree-1.8.7-2012.02 [global]) [gem]" level="application" />
+  </component>
+</module>
+

data/spec/config.yml

@@ -0,0 +1,4 @@
+test:
+  username: test
+  password: test
+  render_path: /render

data/spec/show_images_request_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe SPImaging::ShowImagesRequest do
+  subject do
+    SPImaging::ShowImagesRequest.new(['UUID-1', 'UUID-2'])
+  end
+
+  it 'downloads the file' do
+    server.response = [200, {'content-type' => 'text/plain'}, "test file"]
+
+    response = subject.download
+    response.body.should == "test file"
+    response.content_type.should == 'text/plain'
+    response.content_encoding.should be_nil
+  end
+
+  it 'includes the content encoding' do
+    server.response = [200, {'content-type' => 'text/plain', 'content-encoding' => 'gzip'}, "test file"]
+
+    response = subject.download
+    response.body.should == "test file"
+    response.content_type.should == 'text/plain'
+    response.content_encoding.should == 'gzip'
+  end
+
+  it 'includes the content disposition' do
+    server.response = [200, {'content-type' => 'text/plain', 'content-disposition' => 'attachment; filename=test.txt'}, 'test file']
+    response = subject.download
+    response.content_disposition.should == 'attachment; filename=test.txt'
+  end
+
+  # it 'downloads real content' do
+  #   real_request = SPImaging::ShowImagesRequest.new(['c49abdea-8402-4dd0-914a-e41f6f9c776a', 'ae3227e5-9575-446b-b657-72d8793de7e7'])
+  #   response = real_request.download
+  #   response.content_type.should == 'application/pdf'
+  #   response.content_encoding.should == 'gzip'
+  # end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'spimaging'
+require 'test_server'
+
+require 'tempfile'
+require 'yaml'
+
+RSpec.configure do |config|
+  config.add_setting :server
+  config.add_setting :spimaging_configuration
+
+  config.server = SPImaging::TestServer.new
+  config.server.start
+
+  config.include SPImaging::TestServerHelper
+
+  config.before :suite do
+    ENV['RACK_ENV'] = 'test'
+    ENV['RAILS_ENV'] = 'test'
+
+    yml = Tempfile.new(['spimaging-config', '.yml'])
+    template = YAML.load_file File.join(File.dirname(__FILE__), 'config.yml')
+    template['test'].merge!('base_url' => config.server.base_url)
+    yml.write YAML.dump(template)
+    yml.close
+
+    # yml = Tempfile.new(['spimaging-config', '.yml'])
+    # template = YAML.load_file File.join(File.dirname(__FILE__), 'config.yml')
+    # template['test'].merge!('base_url' => "http://localhost:8081/spimaging/", 'username' => 'secret', 'password' => 'secret')
+    # yml.write YAML.dump(template)
+    # yml.close
+
+    config.spimaging_configuration = yml
+    SPImaging::Configuration.configuration_file = yml.path
+  end
+
+  config.after :suite do
+    config.spimaging_configuration.unlink
+  end
+end

data/spec/test_server.rb

@@ -0,0 +1,52 @@
+require 'net/http'
+require 'rack'
+require 'rack/handler/thin'
+
+module SPImaging
+  class TestServer
+    attr_accessor :env, :response
+
+    def initialize
+      @host = '127.0.0.1'
+      @port = find_available_port
+    end
+
+    def base_url
+      "http://#{@host}:#{@port}"
+    end
+
+    def url(path)
+      URI.join(base_url, path).to_s
+    end
+
+    def call(env)
+      self.env = env
+      response.tap{self.response = nil}
+    end
+
+    def start
+      @thread = Thread.new do
+        Rack::Handler::Thin.run self, :Host => @host, :Port => @port do |server|
+          @server = server
+        end
+      end
+      sleep(0.1) until @server and @server.running?
+    end
+
+    private
+
+    # Stolen from Capybara
+    def find_available_port
+      server = TCPServer.new(@host, 0)
+      server.addr[1]
+    ensure
+      server.close if server
+    end
+  end
+
+  module TestServerHelper
+    def server
+      RSpec.configuration.server
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: ruby-spimaging
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Anthony Marendy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-11-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  name: bundler
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id004 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  name: rake
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.5.9
+  type: :runtime
+  name: nokogiri
+  requirement: *id003
+  prerelease: false
+description: Interfaces to spimaging
+email: 
+- amarendy@sp.com.au
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .idea/.name
+- .idea/.rakeTasks
+- .idea/compiler.xml
+- .idea/encodings.xml
+- .idea/misc.xml
+- .idea/modules.xml
+- .idea/scopes/scope_settings.xml
+- .idea/vcs.xml
+- .idea/workspace.xml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spimaging.rb
+- lib/spimaging/configuration.rb
+- lib/spimaging/protocol.rb
+- lib/spimaging/show_images_request.rb
+- lib/spimaging/show_images_response.rb
+- lib/spimaging/version.rb
+- ruby-spimaging.gemspec
+- ruby-spimaging.iml
+- spec/config.yml
+- spec/show_images_request_spec.rb
+- spec/spec_helper.rb
+- spec/test_server.rb
+homepage: ""
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.11
+signing_key: 
+specification_version: 4
+summary: Downloads a collection of files from spimaging
+test_files: 
+- spec/config.yml
+- spec/show_images_request_spec.rb
+- spec/spec_helper.rb
+- spec/test_server.rb