homeflow_api 0.14.3

data/lib/homeflow/api/favourite_property.rb

@@ -0,0 +1,13 @@
+module Homeflow
+  module API
+   class FavouriteProperty < Resource
+
+    is_resource :favourite_properties
+
+   	def self.create(params)
+      Request.run_for(Homeflow::API::Post.new("/#{resource_uri}/", {}, params))
+    end
+
+   end
+ end
+end

data/lib/homeflow/api/lead.rb

@@ -0,0 +1,13 @@
+module Homeflow
+  module API
+   class Lead < Resource
+
+    is_resource :leads
+
+    def self.create(params)
+      Request.run_for(Homeflow::API::Post.new("/#{resource_uri}/", {}, params))
+    end
+
+   end
+ end
+end

data/lib/homeflow/api/location.rb

@@ -0,0 +1,19 @@
+module Homeflow
+  module API
+   class Location < Resource
+
+    is_resource :locations
+
+
+    #returns a search object pre build withe the correct place id
+    def properties
+      Property.where(:place => {:id => place_id})
+    end
+
+    def self.find_by_county_id_and_location_id(county_id, location_id)
+      Request.run_for(Homeflow::API::ResourceIdentifier.new("/counties/#{county_id}/locations/#{location_id}"))
+    end
+
+   end
+ end
+end

data/lib/homeflow/api/message.rb

@@ -0,0 +1,13 @@
+module Homeflow
+  module API
+    class Message < Resource
+
+      is_resource :messages
+
+      def self.create(params)
+        Request.run_for(Homeflow::API::Post.new("/#{resource_uri}/", {}, params))
+      end
+
+    end
+  end
+end

data/lib/homeflow/api/password_reset.rb

@@ -0,0 +1,13 @@
+module Homeflow
+  module API
+   class PasswordReset < Resource
+
+    is_resource :password_resets
+
+    def self.create(params)
+      Request.run_for(Homeflow::API::Post.new("/#{resource_uri}/", {}, params))
+    end
+
+   end
+ end
+end

data/lib/homeflow/api/place.rb

@@ -0,0 +1,13 @@
+module Homeflow
+  module API
+   class Place < Resource
+
+    is_resource :places
+
+    def self.disambiguate(disambiguation_phrase)
+      Request.run_for(Homeflow::API::ResourceIdentifier.new("/places", :search => {:name => disambiguation_phrase}))
+    end
+
+   end
+ end
+end

data/lib/homeflow/api/portal.rb

@@ -0,0 +1,13 @@
+module Homeflow
+  module API
+   class Portal < Resource
+
+    is_resource :portal
+
+    def self.find()
+      Request.run_for(Homeflow::API::ResourceIdentifier.new("/#{resource_uri}/"))
+    end
+
+   end
+ end
+end

data/lib/homeflow/api/post.rb

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

data/lib/homeflow/api/postcode.rb

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

data/lib/homeflow/api/property.rb

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

data/lib/homeflow/api/put.rb

@@ -0,0 +1,8 @@
+#This module contains class methods used when building up querys on resources. Think index?
+module Homeflow
+  module API
+   class Put < Post
+
+   end
+  end
+end

data/lib/homeflow/api/query.rb

@@ -0,0 +1,85 @@
+#This module contains class methods used when building up querys on resources. Think index?
+module Homeflow
+  module API
+   class Query < RequestSpecification
+
+    attr_accessor :resource_class, :query, :fields, :page, :page_size
+
+    def initialize(resource_class, params)
+      @resource_class = resource_class
+      @fields = []
+      @options = {}
+      @page_size = nil
+      @page =  1
+      search,fields = nil
+      add_search(search) if search = params.delete(:query)
+      set_fields(fields) if fields = params.delete(:fields)
+    end
+
+    def page_size(page_size)
+      @page_size = page_size
+      self
+    end
+
+    def page(page)
+      @page = page
+      self
+    end
+
+    def where(search_hash)
+      add_search(search_hash)
+      self
+    end
+
+    def options(options_hash)
+      @options.merge!(options_hash)
+      self
+    end
+
+    def fields(*args)
+      set_fields(args)
+      self
+    end
+
+    def add_search(search_hash)
+      @query ||= {}
+      @query.merge!(search_hash)
+    end
+
+    def set_fields(fields_array)
+      @fields = fields_array
+    end
+
+    def results
+      @_results ||= results!
+    end
+
+    def results!
+      @_results = @resource_class.execute(self)
+    end
+
+    def response
+      results
+    end
+
+    def each(&block)
+      r = results.send(resource_class.resource_uri)
+      r.each {|k|
+        case block.arity
+          when 1
+            yield k
+          when 2
+            yield k, results
+        end
+      }
+    end
+
+    def to_params
+      options = {}
+      options =  options.merge({:page_size => @page_size}) unless @page_size.nil?
+      options = options.merge({:search => @query, :fields => @fields.join(','), :search_options => @options, :page=> @page})
+    end
+
+   end
+  end
+end

data/lib/homeflow/api/queryable.rb

@@ -0,0 +1,27 @@
+#All 'queryies' go in search[x]
+module Homeflow
+  module API
+	 module Queryable
+
+    def self.included(c)
+      c.extend ClassMethods
+    end
+   
+
+    module ClassMethods
+      def where(query_hash)
+        Homeflow::API::Query.new(self, :query => query_hash)
+      end
+
+      def fields(*args)
+        Homeflow::API::Query.new(self, :fields => args)
+      end
+
+      def execute(query)
+        Request.run_for(query)
+      end
+
+    end
+	 end
+  end
+end

data/lib/homeflow/api/request.rb

@@ -0,0 +1,48 @@
+module Homeflow
+  module API
+   YAML::ENGINE.yamler = "syck"
+   class Request
+
+    attr_accessor :resource_class, :request_specification
+
+    def initialize(request_specification)
+      @request_specification = request_specification
+    end
+
+    def perform
+      begin
+        response = perform_request
+      rescue Errno::ECONNREFUSED => e
+        raise Homeflow::API::Exceptions::APIConnectionError, "Connection error. Homeflow might be down?"
+      end
+      response
+    end
+
+    def perform_request
+      if request_specification.is_a? Query
+        return (HTTParty.get("#{Homeflow::API.config.source}/#{request_specification.resource_class.resource_uri}", :query => @request_specification.to_params.merge(constant_params))).body
+      elsif request_specification.is_a? ResourceIdentifier
+        return (HTTParty.get("#{Homeflow::API.config.source}/#{request_specification.resource_uri}", :query => @request_specification.to_params.merge(constant_params))).body
+      elsif request_specification.is_a? Delete
+        return (HTTParty.delete("#{Homeflow::API.config.source}/#{request_specification.resource_uri}", :query => @request_specification.to_params.merge(constant_params))).body
+      elsif request_specification.is_a? Put
+        return (HTTParty.put("#{Homeflow::API.config.source}/#{request_specification.resource_uri}", :query => @request_specification.to_params.merge(constant_params), :body => @request_specification.post_params)).body
+      elsif request_specification.is_a? Post
+        return (HTTParty.post("#{Homeflow::API.config.source}/#{request_specification.resource_uri}", :query => @request_specification.to_params.merge(constant_params), :body => @request_specification.post_params)).body
+      end
+    end
+
+    def constant_params
+      {:api_key=> Homeflow::API.config.api_key}
+    end
+
+    class << self
+      def run_for(request_specification)
+        r = Request.new(request_specification)
+        Response.new_from_json(r.perform)
+      end
+    end
+    
+   end
+  end
+end

data/lib/homeflow/api/request_specification.rb

@@ -0,0 +1,11 @@
+module Homeflow
+  module API
+   class RequestSpecification
+
+      def to_params
+        raise "this must be implemented"
+      end
+
+   end
+  end
+end

data/lib/homeflow/api/resource.rb

@@ -0,0 +1,27 @@
+module Homeflow
+  module API
+   class Resource < ::Hashie::Mash
+      include Homeflow::API::Queryable
+
+      class << self
+
+        def is_resource(uri)
+          @resource_uri = uri.to_s
+        end
+
+        def find(id, params = {})
+          Request.run_for(Homeflow::API::ResourceIdentifier.new("/#{resource_uri}/#{id}", params))
+        end
+
+        def delete(id, params = {})
+         Request.run_for(Homeflow::API::Delete.new("/#{resource_uri}/#{id}", params))
+        end
+
+        def resource_uri
+          @resource_uri
+        end
+
+      end
+   end
+  end
+end

data/lib/homeflow/api/resource_identifier.rb

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

data/lib/homeflow/api/response.rb

@@ -0,0 +1,108 @@
+module Homeflow
+
+  module API
+   class Response
+
+    def self.new_from_json(json)
+      begin
+       hash = JSON.parse(json) 
+      rescue JSON::ParserError
+        raise Homeflow::API::Exceptions::InvalidResponse
+      end
+      raise Homeflow::API::Exceptions::InvalidResponse unless hash.is_a?(Hash)
+      self.new(hash)
+    end
+
+    attr_accessor :query, :result, :response, :error
+
+
+    COLLECTIONS_OBJECTS = {
+      "password_reset" => Homeflow::API::PasswordReset,
+      "properties" => Homeflow::API::Property,
+      "search" => Homeflow::API::Search,
+      "property" => Homeflow::API::Property,
+      "county" => Homeflow::API::County,
+      "location" => Homeflow::API::Location,
+      "agency" => Homeflow::API::Agency,
+      "agencies" => Homeflow::API::Agency,
+      "locations" => Homeflow::API::Location,
+      "counties" => Homeflow::API::County,
+      "branch" => Homeflow::API::Branch,
+      "branches" => Homeflow::API::Branch,
+      "session" => Homeflow::API::Session,
+      "portal" => Homeflow::API::Portal,
+      'user' => Homeflow::API::User,
+      'message' => Homeflow::API::Message,
+      "lead" => Homeflow::API::Lead,
+      "postcodes" => Homeflow::API::Postcode,
+      "postcode" => Homeflow::API::Postcode,
+      "site_page" => Homeflow::API::SitePage,
+      "site_pages" => Homeflow::API::SitePage,
+      "alternative_places" => {
+        "locations" => Homeflow::API::Location,
+        "counties" => Homeflow::API::County
+      },
+      "favourite_properties" => Homeflow::API::FavouriteProperty
+    } 
+
+    def initialize(hash)
+      @built_result_objects = {}
+      @query = Hashie::Mash.new(hash["query"])
+      @result =  build_result_objects(hash["result"])
+      @response = Hashie::Mash.new(hash["response"])
+      @error = Hashie::Mash.new(hash["error"])
+
+      errors if error.type
+    end
+
+    def method_missing(method, *args, &block)
+      if @built_result_objects.has_key?(method.to_s)
+        @built_result_objects[method.to_s]
+      else
+        super
+      end
+    end
+
+
+    def respond_to?(method, include_private = false)
+      if @built_result_objects.has_key?(method.to_s)
+        true
+      else
+        super
+      end
+    end
+
+    protected
+
+    def errors
+      Homeflow::API::Exceptions::ExceptionsList.list.each do |a|
+        if "Homeflow::API::Exceptions::#{error.type}" == a.name.to_s
+          raise a, error.message
+        end
+      end
+    end
+
+    def build_result_objects(result)
+      COLLECTIONS_OBJECTS.each do |key, o|
+        if result.has_key?(key)
+          if result[key].has_key?("elements")
+            item = Collection.new(result[key], o)
+          elsif o.is_a? Hash
+            hash = {}
+            o.each{|k,v| hash[k.to_sym] = Collection.new(result[key][k], v) if result[key][k]  }
+            item = Hashie::Mash.new(hash)
+          else
+            item = o.new(result[key])
+          end
+        end
+
+        @built_result_objects[key] = item if item
+        item = nil
+      end
+      return result
+    end
+
+     
+   end
+ end
+end