homeflow_api 0.14.3

data/.document

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

data/Gemfile

@@ -0,0 +1,19 @@
+source 'http://rubygems.org'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler"
+  gem "jeweler", "~> 1.6.4"
+end
+
+gem "hashie", "~> 1.1"
+gem "json"
+gem "httparty"
+
+group :test do
+  gem 'test-unit'
+  gem 'shoulda'
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    hashie (1.2.0)
+    httparty (0.9.0)
+      multi_json (~> 1.0)
+      multi_xml
+    i18n (0.6.1)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.7.5)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.4.0)
+    multi_xml (0.5.1)
+    rake (10.0.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.1)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    test-unit (2.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  hashie (~> 1.1)
+  httparty
+  jeweler (~> 1.6.4)
+  json
+  rspec
+  shoulda
+  test-unit

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Homeflow
+
+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,19 @@
+= homeflow_api
+
+The homeflow_api gem provides homeflow api v2 functions from ruby. This is alpha quality software and is in active development.
+
+== Contributing to homeflow_api
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Homeflow. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "homeflow_api"
+  gem.homepage = "http://github.com/homeflow/Homeflow_Api"
+  gem.license = "MIT"
+  gem.summary = %Q{Homeflow API Gem}
+  gem.description = %Q{A gem for dealing the homeflow api}
+  gem.email = "daniel@homeflow.co.uk"
+  gem.authors = ["Daniel Cooper"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "homeflow_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.14.3

data/homeflow_api.gemspec

@@ -0,0 +1,100 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "homeflow_api"
+  s.version = "0.14.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Daniel Cooper"]
+  s.date = "2013-03-06"
+  s.description = "A gem for dealing the homeflow api"
+  s.email = "daniel@homeflow.co.uk"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "homeflow_api.gemspec",
+    "lib/homeflow/api.rb",
+    "lib/homeflow/api/agency.rb",
+    "lib/homeflow/api/branch.rb",
+    "lib/homeflow/api/collection.rb",
+    "lib/homeflow/api/county.rb",
+    "lib/homeflow/api/delete.rb",
+    "lib/homeflow/api/exceptions.rb",
+    "lib/homeflow/api/favourite_property.rb",
+    "lib/homeflow/api/lead.rb",
+    "lib/homeflow/api/location.rb",
+    "lib/homeflow/api/message.rb",
+    "lib/homeflow/api/password_reset.rb",
+    "lib/homeflow/api/place.rb",
+    "lib/homeflow/api/portal.rb",
+    "lib/homeflow/api/post.rb",
+    "lib/homeflow/api/postcode.rb",
+    "lib/homeflow/api/property.rb",
+    "lib/homeflow/api/put.rb",
+    "lib/homeflow/api/query.rb",
+    "lib/homeflow/api/queryable.rb",
+    "lib/homeflow/api/request.rb",
+    "lib/homeflow/api/request_specification.rb",
+    "lib/homeflow/api/resource.rb",
+    "lib/homeflow/api/resource_identifier.rb",
+    "lib/homeflow/api/response.rb",
+    "lib/homeflow/api/search.rb",
+    "lib/homeflow/api/session.rb",
+    "lib/homeflow/api/site.rb",
+    "lib/homeflow/api/site_page.rb",
+    "lib/homeflow/api/user.rb",
+    "spec/data/example_search_response.json",
+    "spec/data/invalid_api_key.json",
+    "spec/data/property_details.json",
+    "spec/data/with_alt_places.json",
+    "spec/homeflow_api_spec.rb",
+    "spec/query_spec.rb",
+    "spec/response_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/homeflow/Homeflow_Api"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Homeflow API Gem"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hashie>, ["~> 1.1"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<hashie>, ["~> 1.1"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<hashie>, ["~> 1.1"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

data/lib/homeflow/api.rb

@@ -0,0 +1,72 @@
+require 'hashie/mash'
+require 'json'
+require 'httparty'
+
+current_dir = File.expand_path(File.dirname(__FILE__))
+
+require current_dir + "/api/request"
+require current_dir + "/api/queryable"
+require current_dir + "/api/resource"
+require current_dir + "/api/collection"
+require current_dir + "/api/request_specification"
+require current_dir + "/api/resource_identifier"
+require current_dir + "/api/post"
+require current_dir + "/api/put"
+require current_dir + "/api/delete"
+require current_dir + "/api/query"
+require current_dir + "/api/exceptions"
+
+require current_dir + "/api/search"
+require current_dir + "/api/property"
+require current_dir + "/api/county"
+require current_dir + "/api/location"
+require current_dir + "/api/place"
+require current_dir + "/api/agency"
+require current_dir + "/api/password_reset"
+require current_dir + "/api/branch"
+require current_dir + "/api/user"
+require current_dir + "/api/session"
+require current_dir + "/api/lead"
+require current_dir + "/api/portal"
+require current_dir + "/api/postcode"
+require current_dir + "/api/site"
+require current_dir + '/api/site_page'
+require current_dir + '/api/message'
+require current_dir + "/api/favourite_property"
+require current_dir + "/api/response"
+
+
+module Homeflow
+  module API
+
+    class << self
+      attr_accessor :configuration
+    end
+
+    # Gets or create a new configuration instance
+    def self.config
+      self.configuration ||= Configuration.new
+    end
+
+    # Provides a block allowing for eacy configuration
+    # ==== Examples
+    #   Homeflow::API.configure do |config|
+    #      config.api_key = "Your api key here"
+    #   end
+    #
+    def self.configure
+      yield(config)
+    end
+
+    # A configuration instance
+    class Configuration
+      attr_accessor :api_key, :source
+
+      def initialize
+        @api_key = 'API_KEY_REQUIRED'
+        @source = 'http://localhost:3000'
+      end
+    end
+
+  end
+end

data/lib/homeflow/api/agency.rb

@@ -0,0 +1,9 @@
+module Homeflow
+  module API
+   class Agency < Resource
+
+    is_resource :agencies
+
+   end
+ end
+end

data/lib/homeflow/api/branch.rb

@@ -0,0 +1,9 @@
+module Homeflow
+  module API
+   class Branch < Resource
+
+    is_resource :branches
+
+   end
+ end
+end

data/lib/homeflow/api/collection.rb

@@ -0,0 +1,22 @@
+#This module contains class methods used when building up querys on resources. Think index?
+module Homeflow
+  module API
+   class Collection < Array
+
+      def initialize(collection_response, klass)
+      	@has_next_page = collection_response["has_next"]
+      	@total = collection_response["total"]
+         collection_response["elements"].each{|element| self << klass.new(element)}
+      end
+      
+
+      def has_next_page?
+      	@has_next_page
+      end
+
+      def total
+      	@total
+      end
+   end
+  end
+end

data/lib/homeflow/api/county.rb

@@ -0,0 +1,10 @@
+module Homeflow
+  module API
+   class County < Resource
+
+    is_resource :counties
+
+
+   end
+ end
+end

data/lib/homeflow/api/delete.rb

@@ -0,0 +1,19 @@
+#This module contains class methods used when building up querys on resources. Think index?
+module Homeflow
+  module API
+   class Delete < RequestSpecification
+
+    attr_accessor :resource_uri
+
+    def initialize(resource_uri, params = {})
+      @resource_uri = resource_uri
+      @params = params
+    end
+
+    def to_params
+      @params
+    end
+
+   end
+  end
+end

data/lib/homeflow/api/exceptions.rb

@@ -0,0 +1,17 @@
+module Homeflow
+  module API
+    module Exceptions
+      class InvalidResponse < StandardError; end
+      class UnknownAPIError < StandardError; end
+      class APIArgumentError < StandardError; end
+      class APIConnectionError < StandardError; end
+
+      class ExceptionsList
+        def self.list
+          [InvalidResponse,APIArgumentError,UnknownAPIError]
+        end
+      end
+
+    end
+  end
+end