innards 0.1.0.pre → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78f09776ea90992633e40d2c52ac744da8581a1a
+  data.tar.gz: 8e2dff4dfd83d89917b53399ff3053ce2eaedf1d
+SHA512:
+  metadata.gz: 567b5f8303e8335ad359a124458702e377ba1bdfc1401442e5890eba95360b6033af2d1d65baa1796f52330edcd80ec1f7e8a1e75bc164f4ea408067fc1571ab
+  data.tar.gz: 830e80d3e29b02391809c574921e0dcf206643e6e2fe355e739e3688aa8448757dc14a09d704d5d1941e30d176137ec29250829f89f4685ccb9365c69d6ad803

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+*.komodoproject
+test.rb

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+gemspec
+
+gem 'coveralls', :require => false

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    innards (0.1.0)
+      excon (~> 0.25.1)
+      multipart-parser (= 0.1.1)
+      ox (~> 2.0.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    coveralls (0.6.7)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.4)
+    excon (0.25.3)
+    mime-types (1.23)
+    multi_json (1.7.7)
+    multipart-parser (0.1.1)
+    ox (2.0.6)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coveralls
+  innards!
+  rake
+  rspec

data/README.md

@@ -1,25 +1,45 @@
+[![Gem Version](https://badge.fury.io/rb/innards.png)](http://badge.fury.io/rb/innards)
 [![Dependency Status](https://gemnasium.com/TurboRETS/innards.png)](https://gemnasium.com/TurboRETS/innards)
-[![Build Status](https://drone.io/github.com/TurboRETS/innards/status.png)](https://drone.io/github.com/TurboRETS/innards/latest)
+[![Build Status](https://travis-ci.org/TurboRETS/innards.png?branch=master)](https://travis-ci.org/TurboRETS/innards)
 [![Code Climate](https://codeclimate.com/github/TurboRETS/innards.png)](https://codeclimate.com/github/TurboRETS/innards)
+[![Coverage Status](https://coveralls.io/repos/TurboRETS/innards/badge.png)](https://coveralls.io/r/TurboRETS/innards)
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/TurboRETS/innards/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 
 TurboRETS Innards
 =================
 
 Gem for accessing RETS Servers
 
-TODO
+Current Status
 -
 - [X] RETS Server Login
-- [ ] Fetch Metadata
-- [ ] Fetch Resource/Class Data
-- [ ] GetObject
+- [X] Fetch Metadata
+- [X] Fetch Resource/Class Data
+- [X] GetObject
+- [ ] RETS 1.7.x User Agent Authentication
 
-Premature Usage Example
+Usage Example
 -
 ```ruby
 require 'innards'
+
 conn = Innards::Connection.new(:login_url => "http://Joe:Schmoe@www.dis.com:6103/rets/login")
 conn.login!
+
+# Fetch metadata
+metadata = conn.get_metadata
+
+# Perform a Search
+results = conn.search :SearchType => "Property",
+                      :Class => "RES",
+                      :Query => "(ListPrice=0+)"
+
+# getObject
+objects = conn.get_object :Type => "Photo",
+                          :Resource => "Property",
+                          :ID => "5:*"
+
+con.logout!
 ```
 
 License

data/Rakefile

@@ -9,4 +9,6 @@ RSpec::Core::RakeTask.new("spec") do |spec|
   spec.pattern = "spec/**/*_spec.rb"
 end
 
+Dir.glob('tasks/*.rake').each {|r| import r}
+
 task :default => :spec

data/innards.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/innards/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "innards"
+  gem.version     = Innards::Version::STRING
+  gem.platform    = Gem::Platform::RUBY
+  gem.authors     = ["Paul Trippett"]
+  gem.email       = ["paul@turborets.com"]
+  gem.homepage    = "http://github.com/TurboRETS/innards"
+  gem.summary     = "RETS Library for Ruby"
+  gem.description = "Innards; the internal parts especially of a structure or mechanism; in our case it's the core RETS library for TurboRETS"
+  
+  gem.license     = "AGPL"
+
+  gem.required_rubygems_version = ">= 1.3.6"
+  gem.rubyforge_project         = "innards"
+
+  gem.add_runtime_dependency "ox", "~>2.0.5"
+  gem.add_runtime_dependency "excon", "~>0.25.1"
+  gem.add_runtime_dependency "multipart-parser", "0.1.1"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+
+  gem.files        = `git ls-files`.split($\)
+  gem.require_path = "lib"
+end

data/lib/innards.rb

@@ -4,4 +4,12 @@ end
 path = File.expand_path("../innards", __FILE__)
 require "#{path}/version"
 require "#{path}/exceptions"
-require "#{path}/connection"
+require "#{path}/digest_handler"
+require "#{path}/cookie_handler"
+require "#{path}/multipart_handler"
+require "#{path}/connection"
+require "#{path}/parsers/parser_base"
+require "#{path}/parsers/login_parser"
+require "#{path}/parsers/logout_parser"
+require "#{path}/parsers/get_metadata_parser"
+require "#{path}/parsers/search_parser"

data/lib/innards/connection.rb

@@ -1,166 +1,255 @@
 require 'uri'
 require 'excon'
 require 'digest/md5'
+require 'ox'
 
 module Innards
+
+  # Creates a connection to a RETS Server managing any required
+  # authentication
   class Connection
-    
+
     include Innards::Exceptions
-    
+
     VALID_RETS_VERSIONS = [
       "1.5",
       "1.7",
       "1.7.2",
       "1.8"
     ]
-    
+
     VALID_AUTH_MODES = [
       "digest",
       "basic"
     ]
-    
+
     DEFAULT_PARAMS = {
       :login_url => "",
-      :login_uri => nil,
-      :proxy_uri => nil,
       :user_agent => "innards/v#{Innards::Version::STRING}",
       :rets_version => "1.7.2",
       :auth_mode => "digest",
+    }
+
+    MASTER_PARAMS = {
+      :request_count => 0,
       :cookies => [],
       :digest => {},
-      :mock => false
+      :login_uri => nil,
+      :proxy_uri => nil
     }
-    
+
+    DEFAULT_SEARCH_OPTIONS = {
+      :SearchType => "",
+      :Class => "",
+      :Query => "",
+      :Format => "COMPACT-DECODED",
+      :QueryType => "DMQL2",
+      :StandardNames => "0",
+      :Limit => "NONE"
+    }
+
+    DEFAULT_GETOBJECT_OPTIONS = {
+      :Type => "",
+      :Resource => "",
+      :ID => ""
+    }
+
+    attr_reader :params
+
     def initialize(params = {})
-      
-      @params = DEFAULT_PARAMS.merge(params)
-      
-      raise ArgumentError.new("invalid url [:login_url]") unless has_valid_url?
-      raise ArgumentError.new("invalid rets version [:rets_version]") unless has_valid_rets_version?
-      raise ArgumentError.new("invalid auth mode [:auth_mode]") unless has_valid_auth_mode?
-      raise ArgumentError.new("invalid user agent [:user_agent]") unless has_valid_user_agent?
-      
+
+      @params = DEFAULT_PARAMS.merge(params).merge(MASTER_PARAMS)
+
+      @digest_handler = DigestHandler.new @params
+      @cookie_handler = CookieHandler.new @params
+
+      raise InvalidUrlException.new unless has_valid_url?
+      raise InvalidRetsVersionException.new unless has_valid_rets_version?
+      raise InvalidAuthModeException.new unless has_valid_auth_mode?
+      raise InvalidUserAgentException.new unless has_valid_user_agent?
+
     end
-    
+
     def login!
-      tries ||= 3
+
       @params[:login_uri] = URI(@params[:login_url])
       @params[:current_request] = @params[:login_uri].path
-      make_request_to @params[:current_request]
-      true
-    rescue AuthenticationRequiredException => e
-      retry unless (tries -= 1).zero?
-      false
+
+      response = make_request_to(@params[:current_request])
+      response_io = StringIO.new(response.body)
+
+      parser = Innards::Parsers::LoginParser.new
+      Ox.sax_parse(parser, response_io)
+
+      if parser.valid_rets_response_received?
+        params[:metadata] = parser.metadata
+        true
+      else
+        false
+      end
+
+    end
+
+    def logout!
+      require_login!
+
+      response = make_request_to(@params[:metadata][:Logout])
+      response_io = StringIO.new(response.body)
+
+      parser = Innards::Parsers::LogoutParser.new
+      Ox.sax_parse(parser, response_io)
+
+      if parser.valid_rets_response_received?
+        params[:metadata] = parser.metadata
+        true
+      else
+        false
+      end
+    end
+
+    def get_metadata options = {}
+      require_login!
+
+      options = {
+        :Type => "METADATA-SYSTEM",
+        :ID => "*",
+        :Format => "COMPACT"
+      }.merge(options)
+
+      response = make_request_to(@params[:metadata][:GetMetadata],
+                                 :query => options)
+      response_io = StringIO.new(response.body)
+
+      parser = Innards::Parsers::GetMetadataParser.new
+      Ox.sax_parse(parser, response_io)
+
+      if parser.valid_rets_response_received?
+        parser.metadata
+      else
+        false
+      end
+    end
+
+    def search options = {}
+      require_login!
+
+      options = DEFAULT_SEARCH_OPTIONS.merge(options)
+
+      raise InvalidSearchTypeException.new if options[:SearchType].empty?
+      raise InvalidClassException.new if options[:Class].empty?
+      raise InvalidQueryException.new if options[:Query].empty?
+
+      response = make_request_to(@params[:metadata][:Search],
+                                 :query => options)
+      response_io = StringIO.new(response.body)
+
+      parser = Innards::Parsers::SearchParser.new
+      Ox.sax_parse(parser, response_io)
+
+      if parser.valid_rets_response_received?
+        parser.results
+      else
+        false
+      end
+    end
+
+    def get_object options = {}
+      require_login!
+
+      options = DEFAULT_GETOBJECT_OPTIONS.merge(options)
+
+      response = make_request_to(@params[:metadata][:GetObject],
+                                 :query => options)
+      response_io = StringIO.new(response.body)
+
+      reader = MultipartHandler.new response.headers["Content-Type"]
+      if reader.is_multipart_response?
+        reader.parse response.body
+      else
+        return response.body
+      end
+
     end
-    
+
     protected
+      def require_login!
+        if @params[:metadata].empty?
+          raise LoginRequiredException.new
+        end
+      end
+
       def has_valid_url?
         (@params[:login_url] =~ URI::regexp)
       end
-      
+
       def has_valid_rets_version?
         VALID_RETS_VERSIONS.include? @params[:rets_version]
       end
-      
+
       def has_valid_auth_mode?
         VALID_AUTH_MODES.include? @params[:auth_mode]
       end
-      
+
       def has_valid_user_agent?
-        !(@params[:user_agent].empty? || @params[:user_agent].nil?)
+        user_agent = @params[:user_agent]
+        !(user_agent.empty? || user_agent.nil?)
       end
-      
+
       def connection
-        @conn = Excon.new("#{@params[:login_uri].scheme}://#{@params[:login_uri].host}:#{@params[:login_uri].port}") if @conn.nil?
+        @conn = Excon.new(build_connection_url) if @conn.nil?
         @conn
       end
-      
-      def make_request_to path
-        response = connection.get(:path => path, :headers => build_headers_for(path))
-        
-        parse_cookie_from(response.headers['Set-Cookie']) if response.headers.has_key?('Set-Cookie')
-        parse_www_authenticate_from(response.headers['WWW-Authenticate']) if response.headers.has_key?('WWW-Authenticate')
-        
-        raise AuthenticationRequiredException.new "Authentication Required" if response.status == 401
-        
+
+      def build_connection_url
+        login_uri = @params[:login_uri]
+        "#{login_uri.scheme}://#{login_uri.host}:#{login_uri.port}"
       end
-      
-      def parse_cookie_from set_cookie_header
-        set_cookie_header.scan(/(\w+)=(.+?);/) {
-          @params[:cookies].push([$1, $2])
-        }
+
+      def make_request_to path, options = {}
+        tries ||= 3
+        @params[:request_count] += 1
+
+        response = connection.get(:path => path,
+                                  :headers => build_headers_for(path),
+                                  :query => options[:query])
+
+        parse_headers_from response
+
+        raise AuthenticationRequiredException.new if response.status == 401
+
+        response
+      rescue StaleDigestException, AuthenticationRequiredException => e
+        retry unless (tries -= 1).zero?
+        raise e
       end
-      
-      def parse_www_authenticate_from www_authenticate_header
-        www_authenticate_header.scan(/(\w+)="(.*?)"/) {
-          @params[:digest][$1] = $2
-        }
+
+      def parse_headers_from response
+        headers = response.headers
+        if headers.has_key?('Set-Cookie')
+          @cookie_handler.parse(headers['Set-Cookie'])
+        end
+
+        if headers.has_key?('WWW-Authenticate')
+          @digest_handler.parse(headers['WWW-Authenticate'])
+        end
       end
-      
+
       def build_headers_for path
         headers = {
           'User-Agent' => @params[:user_agent],
-          'Cookie' => build_cookie_header_for(path),
+          'RETS-Version' => "RETS/#{@params[:rets_version]}"
         }
-        headers['Authorization'] = build_www_authenticate_header_for(path) unless @params[:digest].empty?
-        headers
-      end
-      
-      def build_cookie_header_for path
-        URI.encode_www_form(@params[:cookies]) unless @params[:cookies].empty?
-      end
-      
-      def build_www_authenticate_header_for path
-        cnonce = md5(random)
-        header = [
-          %Q(Digest username="#{@params[:login_uri].user}"),
-          %Q(realm="#{@params[:digest]['realm']}"),
-          %Q(nonce="#{@params[:digest]['nonce']}"),
-          %Q(uri="#{@params[:current_request]}"),
-          %Q(response="#{request_digest(cnonce)}"),
-        ]
-        
-        if has_qop?
-          fields = [
-            %Q(cnonce="#{cnonce}"),
-            %Q(qop="#{@params[:digest]['qop']}"),
-            %Q(nc=00000001)
-          ]
-          fields.each { |field| header << field }
+
+        unless @params[:cookies].empty?
+          headers['Cookie'] = @cookie_handler.build
         end
-        
-        header << %Q(opaque="#{@params[:digest]['opaque']}") if has_opaque?
-        header.join(", ")
-      end
-      
-      def request_digest cnonce
-        a = [md5(a1), @params[:digest]['nonce'], md5(a2)]
-        a.insert(2, "00000001", cnonce, @params[:digest]['qop']) if has_qop?
-        md5(a.join(":"))
-      end
-      
-      def has_opaque?
-        @params[:digest].has_key?('opaque') and !@params[:digest]['opaque'].empty?
-      end
-      
-      def has_qop?
-        @params[:digest].has_key?('qop') and !@params[:digest]['qop'].empty?
-      end
-      
-      def a1
-        [@params[:login_uri].user, @params[:digest]['realm'], @params[:login_uri].password].join(":")
-      end
 
-      def a2
-        ["GET", @params[:current_request]].join(":")
-      end
-      
-      def random
-        "%x" % (Time.now.to_i + rand(65535))
-      end
-      
-      def md5(str)
-        Digest::MD5.hexdigest(str)
+        unless @params[:digest].empty?
+          headers['Authorization'] = @digest_handler.build_for(path)
+        end
+
+        headers
       end
+
   end
-end
+end