ftp_service 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin Blake
+
+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,40 @@
+= FTP Service
+
+An FTP Service is like a web service except stupid. You send your
+request by uploading an xml file and get your response by downloading
+another xml file. Have you ever had to deal with something like that? I
+have.
+
+== Installation
+  
+  gem install ftp_service
+    
+== Usage
+
+  require 'ftp_service'
+  
+  FtpService.open('host', 'user', 'pass') do |service|
+    path = '/the/remote/path'
+    service.write_request("#{path}/request.xml", '<foo>bar</foo>')
+    response = service.read_response("#{path}/response.xml")
+  end
+
+* +read_response+ will block while it polls the server waiting for a
+  response.
+* Temp files are created for the local request and response files and
+  deleted when no longer needed.
+  
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want
+  to have your own version, that is fine but bump version in a commit by
+  itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Justin Blake. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ftp_service"
+    gem.summary = %Q{A class for dealing with the worst possible type of "web" service.}
+    gem.description = %Q{An FTP Service is like a web service except stupid. You send your request by uploading an xml file and get your response by downloading another xml file.}
+    gem.email = "justin@megablaix.com"
+    gem.homepage = "http://github.com/blaix/ftp_service"
+    gem.authors = ["Justin Blake"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ftp_service #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/ftp_service.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ftp_service}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Blake"]
+  s.date = %q{2010-03-05}
+  s.description = %q{An FTP Service is like a web service except stupid. You send your request by uploading an xml file and get your response by downloading another xml file.}
+  s.email = %q{justin@megablaix.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ftp_service.gemspec",
+     "lib/ftp_service.rb",
+     "spec/ftp_service_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/blaix/ftp_service}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A class for dealing with the worst possible type of "web" service.}
+  s.test_files = [
+    "spec/ftp_service_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+  end
+end
+

data/lib/ftp_service.rb

@@ -0,0 +1,40 @@
+require 'net/ftp'
+
+# Class for dealing with a service that acts like a web service, except
+# over FTP. Meaning an xml request is uploaded as a file, and the
+# response xml is downloaded as another file.
+class FtpService
+  
+  # Open a connection to the FTP server and return an FtpService object.
+  # The object must be closed explicitely.
+  #
+  #   ftp_service = FtpService.open(host, user, pass)
+  #   ftp_service.write_request(path, request)
+  #   response = ftp_service.read_response(path)
+  #   ftp_service.close
+  def initialize(host, user, pass)
+    @ftp = Net::FTP.open(host, user, pass)
+  end
+  
+  # Open a connection and pass an FtpService instance to the block. The
+  # instance will be closed when the block finishes, or when an
+  # exception is raised.
+  #
+  #   FtpService.open(host, user, pass) do |ftp_service|
+  #     ftp_service.write_request(path, request)
+  #     response = ftp_service.read_response(path)
+  #   end
+  def self.open(host, user, pass)
+    instance = new(host, user, pass)
+    begin
+      yield(instance)
+    ensure
+      instance.close
+    end
+  end
+  
+  # Close the connection to the FTP server.
+  def close
+    @ftp.close
+  end
+end

data/spec/ftp_service_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "FtpService" do
+  before do
+    @ftp = stub_everything('ftp')
+    Net::FTP.stubs(:open).returns(@ftp)
+  end
+  
+  describe '.new(host, user, pass)' do
+    it 'should connect to the requested ftp server' do
+      Net::FTP.expects(:open).with('host', 'user', 'pass').returns(@ftp)
+      FtpService.new('host', 'user', 'pass')
+    end
+
+    it 'should yield an instance of the ftp service' do
+      service = FtpService.new('host', 'user', 'pass')
+      service.should be_a(FtpService)
+    end
+  end
+  
+  describe '.open(host, user, pass)' do
+    it 'should connect to the requested ftp server' do
+      Net::FTP.expects(:open).with('host', 'user', 'pass').returns(@ftp)
+      FtpService.open('host', 'user', 'pass') {}
+    end
+
+    it 'should yield an instance of the ftp service' do
+      service = nil
+      FtpService.open('host', 'user', 'pass') { |service| }
+      service.should be_a(FtpService)
+    end
+    
+    it 'should automatically close the connection' do
+      @ftp.expects(:close)
+      FtpService.open('host', 'user', 'pass') {}
+    end
+    
+    it 'should close the connection even if an exception is raised' do
+      @ftp.expects(:close)
+      lambda {
+        FtpService.open('host', 'user', 'pass') { raise "boom" }
+      }.should raise_error
+    end
+  end
+  
+  describe '#close' do
+    it 'should close the connection to the ftp server' do
+      @ftp.expects(:close)
+      FtpService.new('host', 'user', 'pass').close
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ftp_service'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: ftp_service
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Justin Blake
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id002
+description: An FTP Service is like a web service except stupid. You send your request by uploading an xml file and get your response by downloading another xml file.
+email: justin@megablaix.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ftp_service.gemspec
+- lib/ftp_service.rb
+- spec/ftp_service_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/blaix/ftp_service
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A class for dealing with the worst possible type of "web" service.
+test_files: 
+- spec/ftp_service_spec.rb
+- spec/spec_helper.rb