easy_broker 0.1.4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee218a0504e6003f7e3016af14294e825984af1059e24e99742175e012d74867
-  data.tar.gz: c4ed7d8a4b5abd8805eae7c3476e253900f5729d5e4189dc4a7db18ecb91d8f4
+  metadata.gz: 45d36d59dcaf0b6a07c5fb9d065711747dca59b66349850fa13f592a04bb9b25
+  data.tar.gz: 634332b115e07adc6710cd84a1a8919a330def6bdcae57348cf54dc8e1308250
 SHA512:
-  metadata.gz: 6daa0c152e04a78f23685e78046ab4a2456776f84c8a2da4caf5b53329ef8d76c7e64dbc727f3bea82674a59bec19307f4621182ce9430e37f62fead07baeb31
-  data.tar.gz: f6b9dc60d9cee16b53f7b61360534a68190591cffc7641d4009334917fe2af42a8d9f382fb1ab0e7089c1b0e69c45120acbe847f74c4b7356008643cf3fc4fa9
+  metadata.gz: c49e16d780adbf8ed5976c6fa0693569f629cb5424e9e84c50f94ee29c8ea373333613eebc4aaa3f2b34e080a8aaf6fd6bc6e025bb2da07eb32882547c6c532e
+  data.tar.gz: c6f04a4c3af67649bd51fb423e11a0059d46e58dba92aee0062c4467a47c55e44ef56aa60a7beeca1581095e1b63e17dd1e8274510ee3b2acb7eadf49611a117

data/.gitignore

@@ -9,4 +9,5 @@
 Gemfile.lock
 /vendor
 .DS_Store
-*.gem
+*.gem
+.idea

data/CHANGELOG.md

@@ -11,3 +11,13 @@
 
 ## 0.1.4
 * Added support for the listing_statuses endpoint.
+
+## 0.1.5
+* Added support for the listing_statuses endpoint for integration partners.
+
+## 1.0.0
+* **Breaking change**: `limit`, `page`, and `search` params should be at the root level requests instead of in the `query` hash.
+* Updated endpoints to use the `api` subdomain; `api.easybroker.com/v1` instead of `www.easybroker.com/api/v1`.
+
+# 1.0.1
+* Added support for agencies, agents, properties and property_integrations endpoints for integration partners.

data/README.md

@@ -61,7 +61,10 @@ results.next_page
 
 
 # Search for only published properties
-client.properties.search(search: { statuses: [:published] } )
+client.properties.search(search: { statuses: [:published] }, limit: 1, page: 1)
+
+# As a partner you can update the property integration on EB
+client.integration_partners.property_integrations.update('EB-123', body: { status: 'successful', listing_url: "https://www.yourwebsite.com/EB-XXXX01" })
 ```
 
 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.
@@ -79,6 +82,13 @@ client.contact_requests # List and search contact requests in your account - TDB
 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
+
+### The following require a partner api key.
+client.integration_partners.agencies # List and search connected agencies.
+client.integration_partners.agents # View detailed agent contact information for those agents assigned to properties.
+client.integration_partners.listing_statuses # List and search the listing status for partner properties.
+client.integration_partners.properties # View the full property listing and its details.
+client.integration_partners.property_integrations # Update the property integration on EB with the listing status on your website.
 ```
 
 ## Development

data/lib/easy_broker/api_client.rb

@@ -20,11 +20,11 @@ class EasyBroker::ApiClient
   end
 
   def post(path, query: {}, body: {})
-    send_request(:post, path, query: query, body: body)
+    send_request(:post, path, query: query, body: body.to_json)
   end
 
   def put(path, query: {}, body: {})
-    send_request(:put, path, query: query, body: body)
+    send_request(:put, path, query: query, body: body.to_json)
   end
 
   def delete(path, query: {})
@@ -34,9 +34,7 @@ class EasyBroker::ApiClient
   private
 
   def send_request(verb, path = '', params = {})
-    query = params[:query] || params['query'] || {}
-
-    self.class.send(verb, path, params.merge(query)).tap do |response|
+    self.class.send(verb, path, params).tap do |response|
       check_errors(response)
       logger&.log response
     end

data/lib/easy_broker/constants.rb

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

data/lib/easy_broker/integration_partners/agencies.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module EasyBroker
+  module IntegrationPartners
+    class Agencies
+      ENDPOINT = '/integration_partners/agencies'
+
+      attr_reader :api_client
+
+      def initialize(api_client)
+        @api_client = api_client
+      end
+
+      def find(agency_id)
+        response = api_client.get("#{ENDPOINT}/#{agency_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
+  end
+end

data/lib/easy_broker/integration_partners/agents.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EasyBroker
+  module IntegrationPartners
+    class Agents
+      ENDPOINT = '/integration_partners/agents'
+
+      attr_reader :api_client
+
+      def initialize(api_client)
+        @api_client = api_client
+      end
+
+      def find(agent_id)
+        response = api_client.get("#{ENDPOINT}/#{agent_id}")
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+    end
+  end
+end

data/lib/easy_broker/integration_partners/listing_statuses.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EasyBroker
+  module IntegrationPartners
+    class ListingStatuses
+      ENDPOINT = '/integration_partners/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
+  end
+end

data/lib/easy_broker/integration_partners/properties.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EasyBroker
+  module IntegrationPartners
+    class Properties
+      ENDPOINT = '/integration_partners/properties'
+
+      attr_reader :api_client
+
+      def initialize(api_client)
+        @api_client = api_client
+      end
+
+      def find(property_id)
+        response = api_client.get("#{ENDPOINT}/#{property_id}")
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+    end
+  end
+end

data/lib/easy_broker/integration_partners/property_integrations.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EasyBroker
+  module IntegrationPartners
+    class PropertyIntegrations
+      ENDPOINT = "/integration_partners/properties/%{property_id}/property_integration"
+
+      attr_reader :api_client
+
+      def initialize(api_client)
+        @api_client = api_client
+      end
+
+      def update(property_id, body: {})
+        response = api_client.put(format(ENDPOINT, property_id: property_id), body: body)
+        JSON.parse(response.body, object_class: OpenStruct)
+      end
+    end
+  end
+end

data/lib/easy_broker/integration_partners/public_client.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module EasyBroker
+  module IntegrationPartners
+    class PublicClient
+      attr_reader :api_client
+
+      def initialize(api_client)
+        @api_client = api_client
+      end
+
+      def agencies
+        EasyBroker::IntegrationPartners::Agencies.new(api_client)
+      end
+
+      def agents
+        EasyBroker::IntegrationPartners::Agents.new(api_client)
+      end
+
+      def listing_statuses
+        EasyBroker::IntegrationPartners::ListingStatuses.new(api_client)
+      end
+
+      def properties
+        EasyBroker::IntegrationPartners::Properties.new(api_client)
+      end
+
+      def property_integrations
+        EasyBroker::IntegrationPartners::PropertyIntegrations.new(api_client)
+      end
+    end
+  end
+end

data/lib/easy_broker/public_client.rb

@@ -26,4 +26,8 @@ class EasyBroker::PublicClient
   def listing_statuses
     EasyBroker::ListingStatuses.new(api_client)
   end
+
+  def integration_partners
+    EasyBroker::IntegrationPartners::PublicClient.new(api_client)
+  end
 end

data/lib/easy_broker/query.rb

@@ -9,8 +9,8 @@ class EasyBroker::Query
     @query_params = query_params
   end
 
-  def get(page = 1)
-    query_params[:page] = page
+  def get(page = nil)
+    query_params[:page] = page if page
     response = api_client.get(endpoint, query: query_params)
     JSON.parse(response.body, object_class: OpenStruct)
   end

data/lib/easy_broker/version.rb

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

data/lib/easy_broker.rb

@@ -13,6 +13,12 @@ require 'easy_broker/mls_properties'
 require 'easy_broker/contact_requests'
 require 'easy_broker/locations'
 require 'easy_broker/listing_statuses'
+require 'easy_broker/integration_partners/public_client'
+require 'easy_broker/integration_partners/agencies'
+require 'easy_broker/integration_partners/agents'
+require 'easy_broker/integration_partners/listing_statuses'
+require 'easy_broker/integration_partners/properties'
+require 'easy_broker/integration_partners/property_integrations'
 
 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.4
+  version: 1.0.1
 platform: ruby
 authors:
 - Eric Northam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-10 00:00:00.000000000 Z
+date: 2022-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -130,6 +130,12 @@ files:
 - lib/easy_broker/constants.rb
 - lib/easy_broker/contact_requests.rb
 - lib/easy_broker/errors.rb
+- lib/easy_broker/integration_partners/agencies.rb
+- lib/easy_broker/integration_partners/agents.rb
+- lib/easy_broker/integration_partners/listing_statuses.rb
+- lib/easy_broker/integration_partners/properties.rb
+- lib/easy_broker/integration_partners/property_integrations.rb
+- lib/easy_broker/integration_partners/public_client.rb
 - lib/easy_broker/listing_statuses.rb
 - lib/easy_broker/locations.rb
 - lib/easy_broker/mls_properties.rb
@@ -158,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A gem to work with EasyBroker's API