picturepath_aui 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 873d479584d386dfbcaf62c0ec693bb76d102137
+  data.tar.gz: 0a8a3cf798434bea07623e01b42e7d0452d436ef
+SHA512:
+  metadata.gz: 852dcb58fd446df4fb375eb452191d1621125b2e468ba49eacbceacc67f4f122ea2088b329eacd80d14ebe70b87738cd0489422731580089525d5110871d31ad
+  data.tar.gz: 05057c67894fe2dce7fd6957e5c79e0e0273383799a00be8021bf49a40e6f0add09d577a372caabd0fb047c1fd5dc2cbc5b70e8f2fdcea12aaa4c40b9851a55c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.4
+  - 2.2.2
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in picturepath_aui.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Antonio Antillon
+
+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,159 @@
+# PicturepathAUI
+
+[![Build Status](https://travis-ci.org/antillas21/picturepath_aui.svg?branch=master)](https://travis-ci.org/antillas21/picturepath_aui)
+[![Code Climate](https://codeclimate.com/github/antillas21/picturepath_aui/badges/gpa.svg)](https://codeclimate.com/github/antillas21/picturepath_aui)
+
+A ruby wrapper around the PicturePath AUI API. PicturePath provides an API to post virtual tours to Realtor.com and other real estate websites.
+
+This gem provides the same functionality than the
+[picturepath](http://picturepath.rubyforge.org/) gem. Only with more
+flexibility and an updated codebase.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'picturepath_aui'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install picturepath_aui
+
+## Usage
+
+We want to keep a simple API to make requests to the PicturePath AUI API.
+
+Here's an example on how to walk the easiest path:
+
+```ruby
+# First, configure your client connection
+client = PicturepathAUI::Client.new(username: "username", password: "password")
+
+# Next, build your request payload
+payload = PicturepathAUI::Request.new({
+  site: 2845, order_number: 1234, product_line: "LINK",
+  street1: "742 Evergreen Terrace", street2: nil, city: "Springfield",
+  state: "IL", zip_code: 62701, mls_id: 5678,
+  tour_url: "http://www.realestateagent.com/tours?id=12345678"
+})
+
+# you can perform a check request (for validation or testing purposes)
+response = client.check(payload)
+
+# to actually send the tour data to Realtor.com, use the :submit method
+response = client.submit(payload)
+
+# either method will return a PicturepathAUI::Response object
+```
+
+### Requests
+
+You don't need to instantiate a `PicturepathAUI::Request` object to perform a
+`:check or :submit` request to the PicturePath AUI API, you can pass XML
+straight to these methods. Example, the following are also valid requests:
+
+```ruby
+xml = File.open("path/to/xml_file.xml").read
+client = PicturepathAUI::Client.new(username: "username", password: "password")
+response = client.check(xml)
+response = client.submit(xml)
+
+str_xml = <<-XML
+<?xml version="1.0" encoding="UTF-8"?>
+<AUI_SUBMISSION VERSION="5.1">
+<TOUR>
+<CUSTREFNUM/>
+<ORDERNUM>1234</ORDERNUM>
+<PRODUCT_LINE>LINK</PRODUCT_LINE>
+<ADDRESS>
+<STREET1>742 Evergreen Terrace</STREET1>
+<STREET2/>
+<CITY>Springfield</CITY>
+<STATE>IL</STATE>
+<COUNTRY CODE="USA"/>
+<ZIP>62701</ZIP>
+</ADDRESS>
+<IDENTIFIERS>
+<ID1 VALUE="1234569" TYPE="MLSID"/>
+<ID2 VALUE="" TYPE="MLSID"/>
+</IDENTIFIERS>
+<DISTRIBUTION>
+<SITE>2845</SITE>
+</DISTRIBUTION>
+<TOUR_URL>http://www.virtualtourco.com/tour.aspx?tourid=12345</TOUR_URL>
+</TOUR>
+</AUI_SUBMISSION>
+XML
+
+client = PicturepathAUI::Client.new(username: "username", password: "password")
+response = client.check(str_xml)
+response = client.submit(str_xml)
+```
+
+However, we thought having a helper class would greatly ease building the XML
+document required by PicturePath :wink:
+
+If building your request through a `PicturepathAUI::Request` object,
+take in mind that:
+
+* `site` key can accept a single value or an Array of values.
+Though PicturePath documentation clearly states that you can provide multiple
+values, they only support `2845`. I don't know what's the point in doing so,
+but still, they "support it", then we allow you to do so.
+* The `PicturepathAUI::Request` object will assing `nil` to any keys you omit in the Hash. Example: You don't pass in a `:street2` key and value, then,
+`Request.street2` will return nil, and the corresponding XML tag will render
+empty (`<STREET2/>`).
+
+### Responses
+
+You will get a `PicturepathAUI::Response` object from a `#check` or `#submit`
+action.
+
+The Response object responds to the following methods:
+
+* `raw`: stores the raw XML response received from the PicturePath AUI API.
+* `data`: stores a parsed version of raw XML in a Hash structure.
+* `order_number`: stores ORDER_NUMBER value if a Submit request was performed.
+* `status`: string value for the overall response status.
+* `messages`: Array of strings with all messages returned in the response.
+* `success?`: true if request was successful.
+* `error?`: true if request response errored out.
+* `warning?`: true if request response returned warning.
+
+### API Version
+
+By default, the `PicturepathAUI::Request` will use the PicturePath AUI API
+version 5.1, however, you can change the API version to use when you
+build out a request:
+
+```ruby
+request = PicturepathAUI::Request.new({
+  api_version: "5.0",
+  # ...other attributes...
+})
+```
+
+Of course you will need to check the documentation as to the fields required
+to populate your `PicturepathAUI::Request` object for the API version you choose.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/antillas21/picturepath_aui. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "picturepath_aui"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/picturepath_aui.rb

@@ -0,0 +1,8 @@
+require "picturepath_aui/version"
+require "picturepath_aui/client"
+require "picturepath_aui/request"
+require "picturepath_aui/response"
+
+module PicturepathAUI
+  # Your code goes here...
+end

data/lib/picturepath_aui/client.rb

@@ -0,0 +1,49 @@
+require 'cgi'
+require 'open-uri'
+
+module PicturepathAUI
+  class Client
+    attr_reader :api_version, :username, :password
+
+    def initialize(attributes = {})
+      @username = attributes.fetch(:username)
+      @password = attributes.fetch(:password)
+      @api_version = attributes.fetch(:api_version, "5.1")
+    end
+
+    def check(payload)
+      post_request(:check, payload)
+    end
+
+    def submit(payload)
+      post_request(:submit, payload)
+    end
+
+    private
+
+    def escape(attribute)
+      return CGI.escape(attribute)
+    end
+
+    def post_request(action, payload)
+      payload = payload.to_xml if payload.is_a?(Request)
+      url = (api_url + aui_default_params(action) + payload_params(payload)).to_s
+      xml = open(url).read
+      return Response.new(xml)
+    end
+
+    def api_url
+      "http://picturepath.homestore.com/picturepath/cgi-bin/receiver.pl"
+    end
+
+    def aui_default_params(action)
+      action_string = action.to_s.capitalize
+      "?username=#{escape(username)}&password=#{escape(password)}&client=AUI&" +
+      "version=#{api_version}&action=#{action_string}"
+    end
+
+    def payload_params(payload)
+      "&xml=#{escape(payload)}"
+    end
+  end
+end

data/lib/picturepath_aui/request.rb

@@ -0,0 +1,58 @@
+require 'builder'
+
+module PicturepathAUI
+  class Request
+    attr_accessor :customer_number, :order_number, :product_sku, :product_line,
+      :street1, :street2, :city, :state, :zip_code, :country, :mls_id, :tour_url,
+      :site, :api_version
+
+    def initialize(attrs = {})
+      [
+        :customer_number, :order_number, :product_sku, :product_line,
+        :street1, :street2, :city, :state, :zip_code, :country, :mls_id,
+        :tour_url, :site
+      ].each do |key|
+        self.instance_variable_set("@#{key}", attrs.fetch(key, nil))
+      end
+
+      @api_version = attrs.fetch(:api_version, "5.1")
+    end
+
+    def to_xml
+      xml = build_xml_document
+      return xml
+    end
+
+    private
+
+    def build_xml_document
+      _xml = Builder::XmlMarkup.new(target: "", indent: 2)
+      _xml.instruct!
+      _xml.AUI_SUBMISSION(VERSION: api_version) {
+        _xml.TOUR {
+          _xml.CUSTREFNUM customer_number
+          _xml.ORDERNUM order_number
+          _xml.PRODUCT_LINE product_line
+          _xml.ADDRESS {
+            _xml.STREET1 street1
+            _xml.STREET2 street2
+            _xml.CITY city
+            _xml.STATE state
+            _xml.COUNTRY(CODE: (country || "USA"))
+            _xml.ZIP zip_code
+          }
+          _xml.IDENTIFIERS {
+            _xml.ID1(VALUE: mls_id, TYPE: "MLSID")
+            _xml.ID2(VALUE: "", TYPE: "MLSID")
+          }
+          _xml.DISTRIBUTION {
+            [site].flatten.each do |s|
+              _xml.SITE s
+            end
+          }
+          _xml.TOUR_URL tour_url
+        }
+      }
+    end
+  end
+end

data/lib/picturepath_aui/response.rb

@@ -0,0 +1,66 @@
+require 'nori'
+require 'nokogiri'
+
+module PicturepathAUI
+  class Response
+    attr_reader :raw, :data, :status, :messages, :order_number
+
+    def initialize(xml)
+      @raw = xml
+      @data = parser.parse(xml)[:aui_response]
+      @status = extract_status(@data)
+      @messages = extract_messages(@data)
+      @order_number = extract_order_number(@data)
+    end
+
+    def success?
+      ["SUCCESS", "PARTIAL SUCCESS"].include?(status)
+    end
+
+    def error?
+      status == "ERROR"
+    end
+
+    def warning?
+      ["WARNING", "GENERAL WARNING"].include?(status)
+    end
+
+    def system_unavailable?
+      status == "SYSTEM UNAVAILABLE"
+    end
+
+    private
+
+    def parser
+      return Nori.new(convert_tags_to: lambda { |tag| tag.snakecase.to_sym })
+    end
+
+    def extract_status(data)
+      return data[:status][:@value]
+    end
+
+    def extract_messages(data)
+      messages = [data[:status][:message]].flatten.map do |message|
+        return [message.strip] if message.is_a?(String)
+        message[:@description].strip
+      end
+
+      return messages.flatten
+    end
+
+    def extract_order_number(data)
+      return nil if is_check_request?(data)
+      return from_status_message(data) if data[:order_number].nil?
+      data[:order_number]
+    end
+
+    def from_status_message(data)
+      order_info = /order number (\w+)/.match(data[:status][:message].to_s)
+      return order_info[1] if order_info.is_a?(MatchData)
+    end
+
+    def is_check_request?(data)
+      data[:status][:@action] == "CHECK"
+    end
+  end
+end

data/lib/picturepath_aui/version.rb

@@ -0,0 +1,3 @@
+module PicturepathAUI
+  VERSION = "0.1.0"
+end

data/picturepath_aui.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'picturepath_aui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "picturepath_aui"
+  spec.version       = PicturepathAUI::VERSION
+  spec.authors       = ["Antonio Antillon"]
+  spec.email         = ["antillas21@gmail.com"]
+
+  spec.summary       = %q{A ruby wrapper around the PicturePath AUI API.}
+  spec.description   = %q{A ruby wrapper around the PicturePath AUI API. PicturePath provides an API to post virtual tours to Realtor.com and other real estate websites.}
+  spec.homepage      = "https://github.com/antillas21/picturepath_aui"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "nori"
+  spec.add_dependency "nokogiri"
+  spec.add_dependency "builder", "~> 3.2"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: picturepath_aui
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Antonio Antillon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A ruby wrapper around the PicturePath AUI API. PicturePath provides an
+  API to post virtual tours to Realtor.com and other real estate websites.
+email:
+- antillas21@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/picturepath_aui.rb
+- lib/picturepath_aui/client.rb
+- lib/picturepath_aui/request.rb
+- lib/picturepath_aui/response.rb
+- lib/picturepath_aui/version.rb
+- picturepath_aui.gemspec
+homepage: https://github.com/antillas21/picturepath_aui
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper around the PicturePath AUI API.
+test_files: []