easy_broker 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e776eb6519e1c3bfcb77a951c47b78d89d425665c9400149ed75b792e6fa7cef
-  data.tar.gz: 7297f553a3f882198d86cc1857750795fefb76a2afdddb3a8fefd15f2a704d74
+  metadata.gz: ee218a0504e6003f7e3016af14294e825984af1059e24e99742175e012d74867
+  data.tar.gz: c4ed7d8a4b5abd8805eae7c3476e253900f5729d5e4189dc4a7db18ecb91d8f4
 SHA512:
-  metadata.gz: 19205db9c8dde2f1e2024ddc2c1be72e2bdee469dd6a5ff7403fd7f65ac21d3714e4599fb40ac2c5e4f52e4394d768f285ead5bf1260bd8f6f22a190515d90e9
-  data.tar.gz: 3264d842b5195beca8060faab72b2bdb53991680a0230877ab9ce01eaf333c229590a5e62c359f9019e7b259b4ff8accdfce6d21c5cfe2e533a0344ddd80411d
+  metadata.gz: 6daa0c152e04a78f23685e78046ab4a2456776f84c8a2da4caf5b53329ef8d76c7e64dbc727f3bea82674a59bec19307f4621182ce9430e37f62fead07baeb31
+  data.tar.gz: f6b9dc60d9cee16b53f7b61360534a68190591cffc7641d4009334917fe2af42a8d9f382fb1ab0e7089c1b0e69c45120acbe847f74c4b7356008643cf3fc4fa9

data/CHANGELOG.md

@@ -1,4 +1,13 @@
 # Changelog
 
 ## 0.1.1
-* Initial release
+* Initial release.
+
+## 0.1.2
+* Added support for contact_requests, mls_properties and locations endpoints.
+
+## 0.1.3
+* Fixed pagination bug where the last page may not have been included.
+
+## 0.1.4
+* Added support for the listing_statuses endpoint.

data/README.md

@@ -1,6 +1,6 @@
 # EasyBroker
 
-A gem that makes it easy to work with the [EasyBroker API](https://api.easybroker.com/api/playground).
+A gem that makes it easy to work with the [EasyBroker API](https://api.easybroker.com/).
 
 ## Installation
 
@@ -28,7 +28,7 @@ EasyBroker.configure do |config|
   config.api_key = 'your_app_key'
 
   # Optionally change the root API URL
-  # config.api_root_url = 'https://www.myebproxy.com/api/v1/'
+  # config.api_root_url = EasyBroker::STAGING_API_ROOT_URL
 end
 ```
 
@@ -50,6 +50,16 @@ results.find_each do |property|
   puts property.public_id
 end
 
+# The total number of results of all pages
+results.total 
+
+# The current page
+results.page 
+
+# Loads the next page results
+results.next_page 
+
+
 # Search for only published properties
 client.properties.search(search: { statuses: [:published] } )
 ```
@@ -57,7 +67,18 @@ client.properties.search(search: { statuses: [:published] } )
 You can also pass a logger to log any methods that make remote calls. The logger class must implement a `log` method which will be called with the [HTTParty response](https://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/Response) for every remote request sent.
 
 ```ruby
-EasyBroker.api_client(logger: my_logger)
+EasyBroker.client(logger: my_logger)
+```
+
+## Available Endpoints
+
+
+```ruby
+client.locations # List and search geographic locations
+client.contact_requests # List and search contact requests in your account - TDB create via post
+client.properties # List, search and find properties in your account
+client.mls_properties # List, search and find properties in the MLS - requires MLS API Plan
+client.listing_statuses # List and search the listing status for properties. Great for syncing large sets of properties. - includes MLS properties if you have the MLS Plan
 ```
 
 ## Development

data/easy_broker.gemspec

@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "httparty", "~> 0.18"
 
-  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "bundler", "~> 2.2"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry"

data/lib/easy_broker/constants.rb

@@ -6,5 +6,6 @@ module EasyBroker
     'User-Agent' => USER_AGENT
   }
   DEFAULT_API_ROOT_URL = 'https://www.easybroker.com/api/v1'
+  STAGING_API_ROOT_URL = 'https://www.stagingeb.com/api/v1'
   AUTHORIZATION_HEADER = 'X-Authorization'
 end

data/lib/easy_broker/contact_requests.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class EasyBroker::ContactRequests
+  ENDPOINT = '/contact_requests'
+
+  attr_reader :api_client
+
+  def initialize(api_client)
+    @api_client = api_client
+  end
+
+  def search(query = {})
+    stored_query = EasyBroker::Query.new(api_client, ENDPOINT, query)
+    EasyBroker::PaginatedResponse.new(stored_query)
+  end
+end

data/lib/easy_broker/listing_statuses.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class EasyBroker::ListingStatuses
+  ENDPOINT = '/listing_statuses'
+
+  attr_reader :api_client
+
+  def initialize(api_client)
+    @api_client = api_client
+  end
+
+  def search(query = {})
+    stored_query = EasyBroker::Query.new(api_client, ENDPOINT, query)
+    EasyBroker::PaginatedResponse.new(stored_query)
+  end
+end

data/lib/easy_broker/locations.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+class EasyBroker::Locations
+  ENDPOINT = '/locations'
+
+  attr_reader :api_client
+
+  def initialize(api_client)
+    @api_client = api_client
+  end
+
+  def search(query = {})
+    stored_query = EasyBroker::Query.new(api_client, ENDPOINT, query)
+    EasyBroker::PaginatedResponse.new(stored_query)
+  end
+end

data/lib/easy_broker/mls_properties.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class EasyBroker::MlsProperties
+  ENDPOINT = '/mls_properties'
+
+  attr_reader :api_client
+
+  def initialize(api_client)
+    @api_client = api_client
+  end
+
+  def find(public_id)
+    response = api_client.get("#{ENDPOINT}/#{public_id}") 
+    JSON.parse(response.body, object_class: OpenStruct)
+  end
+
+  def search(query = {})
+    stored_query = EasyBroker::Query.new(api_client, ENDPOINT, query)
+    EasyBroker::PaginatedResponse.new(stored_query)
+  end
+end

data/lib/easy_broker/paginated_response.rb

@@ -17,14 +17,12 @@ class EasyBroker::PaginatedResponse
   end
 
   def page
-    pagination&.page
+    pagination&.page || 1
   end
 
   def next_page
-    next_page_number = page.nil? ? 1 : page + 1
-
-    if next_page_number * limit <= total
-      @response = query.get(next_page_number)
+    if page * limit < total
+      @response = query.get(page + 1)
     end
   end
 
@@ -51,4 +49,4 @@ class EasyBroker::PaginatedResponse
   def pagination
     response&.pagination
   end
-end
+end

data/lib/easy_broker/public_client.rb

@@ -10,4 +10,20 @@ class EasyBroker::PublicClient
   def properties
     EasyBroker::Properties.new(api_client)
   end
+
+  def mls_properties
+    EasyBroker::MlsProperties.new(api_client)
+  end
+
+  def contact_requests
+    EasyBroker::ContactRequests.new(api_client)
+  end
+
+  def locations
+    EasyBroker::Locations.new(api_client)
+  end
+
+  def listing_statuses
+    EasyBroker::ListingStatuses.new(api_client)
+  end
 end

data/lib/easy_broker/version.rb

@@ -1,3 +1,3 @@
 module EasyBroker
-  VERSION = "0.1.1"
+  VERSION = "0.1.4"
 end

data/lib/easy_broker.rb

@@ -9,6 +9,10 @@ require 'easy_broker/public_client'
 require 'easy_broker/paginated_response'
 require 'easy_broker/query'
 require 'easy_broker/properties'
+require 'easy_broker/mls_properties'
+require 'easy_broker/contact_requests'
+require 'easy_broker/locations'
+require 'easy_broker/listing_statuses'
 
 module EasyBroker
   def self.configuration

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_broker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - Eric Northam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-18 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,11 @@ files:
 - lib/easy_broker/api_client.rb
 - lib/easy_broker/configuration.rb
 - lib/easy_broker/constants.rb
+- lib/easy_broker/contact_requests.rb
 - lib/easy_broker/errors.rb
+- lib/easy_broker/listing_statuses.rb
+- lib/easy_broker/locations.rb
+- lib/easy_broker/mls_properties.rb
 - lib/easy_broker/paginated_response.rb
 - lib/easy_broker/properties.rb
 - lib/easy_broker/public_client.rb
@@ -154,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: A gem to work with EasyBroker's API