Module: Homeflow::API

Defined in:
lib/homeflow/api.rb,
lib/homeflow/api/put.rb,
lib/homeflow/api/lead.rb,
lib/homeflow/api/post.rb,
lib/homeflow/api/site.rb,
lib/homeflow/api/user.rb,
lib/homeflow/api/place.rb,
lib/homeflow/api/query.rb,
lib/homeflow/api/agency.rb,
lib/homeflow/api/branch.rb,
lib/homeflow/api/county.rb,
lib/homeflow/api/delete.rb,
lib/homeflow/api/portal.rb,
lib/homeflow/api/search.rb,
lib/homeflow/api/message.rb,
lib/homeflow/api/request.rb,
lib/homeflow/api/session.rb,
lib/homeflow/api/location.rb,
lib/homeflow/api/postcode.rb,
lib/homeflow/api/property.rb,
lib/homeflow/api/resource.rb,
lib/homeflow/api/response.rb,
lib/homeflow/api/queryable.rb,
lib/homeflow/api/site_page.rb,
lib/homeflow/api/collection.rb,
lib/homeflow/api/exceptions.rb,
lib/homeflow/api/password_reset.rb,
lib/homeflow/api/favourite_property.rb,
lib/homeflow/api/site_content_chunk.rb,
lib/homeflow/api/resource_identifier.rb,
lib/homeflow/api/request_specification.rb

Defined Under Namespace

Modules: Exceptions, Queryable Classes: Agency, Branch, Collection, Configuration, County, Delete, FavouriteProperty, Lead, Location, Message, PasswordReset, Place, Portal, Post, Postcode, Property, Put, Query, Request, RequestSpecification, Resource, ResourceIdentifier, Response, Search, Session, Site, SiteContentChunk, SitePage, User

Constant Summary collapse

VERSION = 
"1.0.2"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.configuration ⇒ Object

Returns the value of attribute configuration.



46
47
48
 
# File 'lib/homeflow/api.rb', line 46

def configuration
  @configuration
end

Class Method Details

.config ⇒ Object

Gets or create a new configuration instance



50
51
52
 
# File 'lib/homeflow/api.rb', line 50

def self.config
  self.configuration ||= Configuration.new
end

.configure {|config| ... } ⇒ Object

Provides a block allowing for eacy configuration

Examples

Homeflow::API.configure do |config|
   config.api_key = "Your api key here"
end

Yields:



60
61
62
 
# File 'lib/homeflow/api.rb', line 60

def self.configure
  yield(config)
end