sean-rets 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 679f076c80dc81f0dc15aecb394ff3435250244f
+  data.tar.gz: 4c287ca2d5ed9e28617cc3890701fa7e5d41707c
+SHA512:
+  metadata.gz: fcdde80697677da90f2952749b1259e88cee217c11f2b2a122584bf55424dc8defe9f782f0d03262d5a448dbcc0afcb570277831543af028dbcfa117c5426dd9
+  data.tar.gz: 0192696920f4fa35c48139503dc0db6d762b7902603555b401398d545ea8733a8c4c07efa2653f186113bfc6335b3a5f339f042b49a15e06145a31e4529172b5

data/CHANGELOG.md

@@ -0,0 +1,89 @@
+### 0.6.0 / 2013-10-30
+
+* fix: fix spelling error that created misleading exceptions
+* feature: track stats for http requests sent
+* feature: raise an exception if the login action doesn't return an http 200 status
+* feature: add better class description and more fields to print tree
+* feature: support http proxies
+* feature: customizable http timeouts
+* feature: add logging http headers when in debug mode
+* feature: strip invalid utf8 from responses before parsing
+* fix: don't raise an exception on a 401 after logout
+* fix: treat no matching records status without a count node as a zero count
+* feature: add an option for loading custom ca_certs
+* feature: remove invalid resource types from metadata
+* feature: special case http 412
+* feature: add max_retries option
+
+### 0.5.1 / 2013-10-30
+
+* fix: 0.5.0 was broken, fix gem Manifest to fix gem
+
+### 0.5.0 / 2013-09-05
+
+* feature: Allow client.count to get integer count
+* feature: Allow for downcased capability names
+* fix: Handle the rets element being empty
+* feature: Instrument rets client with stats reporting
+* feature: Add a locking client
+* feature: Support Basic Authentication
+
+### 0.4.0 / 2012-08-29
+
+* fix: update authentication header to uri matches path
+
+### 0.3.0 / 2012-07-31
+
+* correctly handle digest authentication
+
+### 0.3.0.rc.0 / 2012-07-26
+
+* feature: significantly better handling of authorization failures
+
+### 0.2.1 / 2012-04-20
+
+* fix: better handling of malformed RETS responses
+
+### 0.2.0 / 2012-04-20
+
+* feature: Ruby 1.9 compatibility!
+
+### 0.1.7 / 2012-04-05
+
+* feature: key_field lookup for resources
+
+### 0.1.6 / 2012-04-03
+
+* fix: user_agent authentication
+
+### 0.1.5 / 2012-03-17
+
+* fix: retries raise error after too many failures
+* fix: raise error for failed multipart object request
+* fix: retries start with a clean slate, fixing authorization errors during retry
+
+### 0.1.4 / 2012-03-12
+
+* fix: an MLS uses lower case in RETS tag
+
+### 0.1.3 / 2012-03-05
+
+* fixes to support location=1 in getobject query
+
+### 0.1.2 / 2012-02-17
+
+* bugfix - check ReplyCode in login, retry on errors
+
+### 0.1.1 / 2012-01-11
+
+* bugfix - prevent infinite loop in login
+
+# rets Changelog
+
+### 0.1.0 / 2011-06-23
+
+* First public release!
+
+### 0.0.1 / 2011-03-24
+
+* Project Created

data/Manifest.txt

@@ -0,0 +1,28 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+bin/rets
+lib/rets.rb
+lib/rets/client.rb
+lib/rets/client_progress_reporter.rb
+lib/rets/http_client.rb
+lib/rets/locking_http_client.rb
+lib/rets/measuring_http_client.rb
+lib/rets/metadata.rb
+lib/rets/metadata/containers.rb
+lib/rets/metadata/lookup_type.rb
+lib/rets/metadata/resource.rb
+lib/rets/metadata/rets_class.rb
+lib/rets/metadata/root.rb
+lib/rets/metadata/table.rb
+lib/rets/parser/compact.rb
+lib/rets/parser/multipart.rb
+test/fixtures.rb
+test/helper.rb
+test/test_client.rb
+test/test_locking_http_client.rb
+test/test_metadata.rb
+test/test_parser_compact.rb
+test/test_parser_multipart.rb
+test/vcr_cassettes/unauthorized_response.yml

data/README.md

@@ -0,0 +1,47 @@
+# rets
+
+* http://github.com/estately/rets
+
+## DESCRIPTION:
+
+[![Build Status](https://secure.travis-ci.org/estately/rets.png?branch=master)](http://travis-ci.org/estately/rets)
+A pure-ruby library for fetching data from [RETS] servers.
+
+[RETS]: http://www.rets.org
+
+## REQUIREMENTS:
+
+* [net-http-persistent]
+* [nokogiri]
+
+[net-http-persistent]: http://seattlerb.rubyforge.org/net-http-persistent/
+[nokogiri]: http://nokogiri.org
+
+## EXAMPLE USAGE:
+
+We need work in this area! There are currently a few guideline examples in the `example` folder on connecting, fetching a property's data, and fetching a property's photos.
+ 
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Estately, Inc. <opensource@estately.com>
+
+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/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'hoe'
+require 'rake/testtask'
+
+Hoe.plugin :git, :doofus
+Hoe.plugin :travis
+Hoe.plugin :gemspec
+
+Hoe.spec 'rets' do
+  developer 'Estately, Inc. Open Source', 'opensource@estately.com'
+
+  extra_deps << [ "httpclient", "~> 2.3.0" ]
+  extra_deps << [ "nokogiri",            "~> 1.5.2" ]
+
+  extra_dev_deps << [ "mocha", "~> 0.11.0" ]
+  extra_dev_deps << [ "vcr", "~> 2.2.2" ]
+  extra_dev_deps << [ "webmock", "~> 1.8.0" ]
+
+  ### Use markdown for changelog and readme
+  self.history_file = 'CHANGELOG.md'
+  self.readme_file  = 'README.md'
+end
+
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/test_*.rb"
+end

data/bin/rets

@@ -0,0 +1,202 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "pp"
+
+require "rubygems"
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require "rets"
+
+class RetsCli
+  def self.parse(args)
+
+    actions = %w(metadata search count object)
+    options = {:count => 5}
+
+    opts = OptionParser.new do |opts|
+      opts.banner = "Usage: #{File.basename($0)} URL [options] [query]"
+
+      opts.separator ""
+      opts.separator "Authentication options:"
+
+      opts.on("-U", "--username USERNAME", "The username to authenticate with.") do |username|
+        options[:username] = username
+      end
+
+      opts.on("-P", "--password [PASSWORD]", "The password to authenticate with.","Prompts if no argument is provided.") do |password|
+        options[:password] = password #or prompt # TODO
+      end
+
+      opts.on("-A", "--agent AGENT", "User-Agent header to provide.") do |agent|
+        options[:agent] = agent
+      end
+
+      opts.on("-B", "--agent-password [PASSWORD]", "User-Agent password to provide.") do |ua_password|
+        options[:ua_password] = ua_password
+      end
+
+      opts.separator ""
+      opts.separator "Actions:"
+
+      opts.on("-p", "--capabilities", "Print capabilities of the RETS server.") do |capabilities|
+        options[:capabilities] = capabilities
+      end
+
+      opts.on("-a", "--action ACTION", actions, "Action to perform (#{actions.join(",")}).") do |action|
+        options[:action] = action
+      end
+
+      opts.on("-m", "--metadata [FORMAT]", %w(tree long short), "Print metadata.", "Format is short, long or tree.", "Defaults to short.") do |format|
+        options[:action] = "metadata"
+        options[:metadata_format] = format || "short"
+      end
+
+      opts.separator ""
+      opts.separator "Search action options:"
+
+      opts.on("-r", "--resource NAME", "Name of resource to search for.") do |name|
+        options[:resource] = name
+      end
+
+      opts.on("-c", "--class NAME", "Name of class to search for.") do |name|
+        options[:class] = name
+      end
+
+      opts.on("-n", "--number LIMIT", Integer, "Return LIMIT results. Defaults to 5.") do |limit|
+        options[:limit] = limit
+      end
+
+      opts.separator ""
+      opts.separator "Misc options:"
+
+      opts.on_tail("-v", "--verbose", "Be verbose.") do |verbose|
+        logger = Class.new do
+          def method_missing(method, *a, &b)
+            puts a
+          end
+        end
+
+        options[:logger] = logger.new
+      end
+
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+
+      opts.on_tail("--version", "Show version") do
+        puts Rets::VERSION
+        exit
+      end
+
+    end
+
+    begin
+      opts.parse!(args.empty? ? ["-h"] : args)
+    rescue OptionParser::InvalidArgument => e
+      abort e.message
+    end
+
+    options
+  end
+
+end
+
+options = RetsCli.parse(ARGV)
+url     = ARGV[0] or abort "Need login URL"
+query   = ARGV[1]
+
+client = Rets::Client.new(options.merge(:login_url => url))
+
+if options[:capabilities]
+  pp client.capabilities
+end
+
+case options[:action]
+  when "metadata" then
+    metadata = client.metadata
+
+    if options[:metadata_format] != "tree"
+      preferred_fields = %w(ClassName SystemName ResourceID StandardName VisibleName MetadataEntryID KeyField)
+
+
+      # All types except system
+      types = Rets::METADATA_TYPES.map { |t| t.downcase.to_sym } - [:system]
+
+      types.each do |type|
+        # if RowContainer ...
+        rows = metadata[type]
+
+        puts type.to_s.capitalize
+        puts "="*40
+
+        print_key_value = lambda do |k,v|
+          key   = "#{k}:".ljust(35)
+          value = "#{v}".ljust(35)
+
+          puts [key, value].join
+        end
+
+        rows.each do |row|
+          top, rest = row.partition { |k,v| preferred_fields.include?(k) }
+
+          top.each(&print_key_value)
+
+          rest.sort_by{|k,v|k}.each(&print_key_value) if options[:metadata_format] == "long"
+
+          puts
+        end
+
+        puts
+      end
+
+    # Tree format
+    else
+      metadata.print_tree
+    end
+
+  when "search" then
+    pp client.find(:all,
+                  :search_type => options[:resource],
+                  :class       => options[:class],
+                  :query       => query,
+                  :count       => Rets::Client::COUNT.exclude,
+                  :limit       => options[:limit])
+
+  when "count" then
+    pp client.find(:all,
+              :search_type => options[:resource],
+              :class       => options[:class],
+              :query       => query,
+              :count       => Rets::Client::COUNT.only,
+              :limit       => options[:limit])
+
+  when "object" then
+
+    def write_objects(parts)
+      parts.each do |part|
+        cid = part.headers["content-id"].to_i
+        oid = part.headers["object-id"].to_i
+
+        File.open("tmp/#{cid}-#{oid}", "wb") do |f|
+          puts f.path
+
+          f.write part.body
+        end
+      end
+    end
+
+    parts = client.all_objects(
+      :resource    => "Property",
+      :resource_id => 90020062739, # id from KeyField for a given property
+      :object_type => "Photo"
+    )
+
+    parts.each { |pt| p pt.headers }
+
+    write_objects(parts)
+
+end
+
+client.logout

data/lib/rets.rb

@@ -0,0 +1,45 @@
+require 'uri'
+require 'digest/md5'
+require 'nokogiri'
+
+module Rets
+  VERSION = '0.6.0'
+
+  MalformedResponse    = Class.new(ArgumentError)
+  UnknownResponse      = Class.new(ArgumentError)
+  NoLogout             = Class.new(ArgumentError)
+
+  class AuthorizationFailure < ArgumentError
+    attr_reader :status, :body
+    def initialize(status, body)
+      @status = status
+      @body = body
+      super("HTTP status: #{status} (#{body})")
+    end
+  end
+
+  class InvalidRequest < ArgumentError
+    attr_reader :error_code, :reply_text
+    def initialize(error_code, reply_text)
+      @error_code = error_code
+      @reply_text = reply_text
+      super("Got error code #{error_code} (#{reply_text})")
+    end
+  end
+
+  class UnknownCapability < ArgumentError
+    attr_reader :capability_name
+    def initialize(capability_name)
+      @capability_name = capability_name
+      super("unknown capability #{capability_name}")
+    end
+  end
+end
+
+require 'rets/client'
+require 'rets/metadata'
+require 'rets/parser/compact'
+require 'rets/parser/multipart'
+require 'rets/measuring_http_client'
+require 'rets/locking_http_client'
+require 'rets/client_progress_reporter'