innards 0.1.0.pre

data/LICENSE.txt

@@ -0,0 +1,14 @@
+Copyright (c) 2013 TurboRETS
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/README.md

@@ -0,0 +1,27 @@
+[![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)
+[![Code Climate](https://codeclimate.com/github/TurboRETS/innards.png)](https://codeclimate.com/github/TurboRETS/innards)
+
+TurboRETS Innards
+=================
+
+Gem for accessing RETS Servers
+
+TODO
+-
+- [X] RETS Server Login
+- [ ] Fetch Metadata
+- [ ] Fetch Resource/Class Data
+- [ ] GetObject
+
+Premature Usage Example
+-
+```ruby
+require 'innards'
+conn = Innards::Connection.new(:login_url => "http://Joe:Schmoe@www.dis.com:6103/rets/login")
+conn.login!
+```
+
+License
+-
+Distributed under an AGPL license, see LICENSE file

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler"
+Bundler.setup
+
+require "rake"
+require "rspec"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec") do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/innards.rb

@@ -0,0 +1,7 @@
+module Innards
+end
+
+path = File.expand_path("../innards", __FILE__)
+require "#{path}/version"
+require "#{path}/exceptions"
+require "#{path}/connection"

data/lib/innards/connection.rb

@@ -0,0 +1,166 @@
+require 'uri'
+require 'excon'
+require 'digest/md5'
+
+module Innards
+  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",
+      :cookies => [],
+      :digest => {},
+      :mock => false
+    }
+    
+    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?
+      
+    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
+    end
+    
+    protected
+      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?)
+      end
+      
+      def connection
+        @conn = Excon.new("#{@params[:login_uri].scheme}://#{@params[:login_uri].host}:#{@params[:login_uri].port}") 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
+        
+      end
+      
+      def parse_cookie_from set_cookie_header
+        set_cookie_header.scan(/(\w+)=(.+?);/) {
+          @params[:cookies].push([$1, $2])
+        }
+      end
+      
+      def parse_www_authenticate_from www_authenticate_header
+        www_authenticate_header.scan(/(\w+)="(.*?)"/) {
+          @params[:digest][$1] = $2
+        }
+      end
+      
+      def build_headers_for path
+        headers = {
+          'User-Agent' => @params[:user_agent],
+          'Cookie' => build_cookie_header_for(path),
+        }
+        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 }
+        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)
+      end
+  end
+end

data/lib/innards/exceptions.rb

@@ -0,0 +1,8 @@
+module Innards
+  module Exceptions
+    
+    class AuthenticationRequiredException < Exception
+    end
+    
+  end
+end

data/lib/innards/version.rb

@@ -0,0 +1,10 @@
+module Innards
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    BUILD = 'pre'
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: innards
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Paul Trippett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.25.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.25.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+description: Innards; the internal parts especially of a structure or mechanism; in
+  our case it's the core RETS library for TurboRETS
+email:
+- paul@turborets.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/innards/connection.rb
+- lib/innards/exceptions.rb
+- lib/innards/version.rb
+- lib/innards.rb
+- LICENSE.txt
+- README.md
+- Rakefile
+homepage: http://github.com/TurboRETS/innards
+licenses:
+- AGPL
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: innards
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: RETS Library for Ruby
+test_files: []