easy_broker 0.1.5 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5c3fc54d9f30598f2a8499cb0be351a5daa7cd03a1bd91f022cb2da545f0b3a1
-  data.tar.gz: b0407234c841d6b3bf29151e83501f1a7006fb381e0b644acbdb8ef7cf416662
+  metadata.gz: 417f7f736a72535965e55d9223869e88f6f3f9e14a055668f8dfe7c165ed0d45
+  data.tar.gz: c7196e2f63f4cebe1e9483ce909fdd2be313935d6cca05f5261686e96f4acf58
 SHA512:
-  metadata.gz: 409d82992dd0aa86164ca350fde1c5cd4a7fcadfc7961b2f14d7b2f4bfeb8eeaad4cd477a926e857dd480603a2fa7dd61a8821cff9d5da7e23c3c0cb4dbda511
-  data.tar.gz: c4be1cfa701a33490147c4ce2b45d976eda66aececa774ba30c1dc612bdc259cad335e7d8a72d175bf9f8194ce2c5f3167f224b9e47c028033a68896295bdfc0
+  metadata.gz: 05d8a95e19cb55312fc15bc5150d126e26540dea895cfb397ffc4fe896d73a9a7b44c8ba3ed9c54c5bc4c16680a7b350b204b2132cd1a4619b69595c74ff8fdc
+  data.tar.gz: a6fee3cde01a6f5381b0aa2e189ff808e88377de181b483b8a37699a15cb8c0de80d38e2b0b63d935466cebfb32141b9b5b5f08623b88218e9e5cc790ac211da

data/CHANGELOG.md

@@ -14,3 +14,13 @@
 
 ## 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.
+
+# 1.0.2
+* Added support to configure the country code header for integration partners endpoints.

data/README.md

@@ -29,6 +29,9 @@ EasyBroker.configure do |config|
 
   # Optionally change the root API URL
   # config.api_root_url = EasyBroker::STAGING_API_ROOT_URL
+
+  # As an integration partner you must configure the country code
+  # config.country_code = 'MX'
 end
 ```
 
@@ -61,7 +64,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,7 +85,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
-client.integration_partners.listing_statuses # List and search the listing status for partner properties. Requires an integration partner api key.
+
+### 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

@@ -10,8 +10,9 @@ class EasyBroker::ApiClient
   def initialize(logger: nil)
     self.class.base_uri EasyBroker.configuration.api_root_url
     self.class.headers EasyBroker::DEFAULT_HEADERS.merge(
-      EasyBroker::AUTHORIZATION_HEADER => EasyBroker.configuration.api_key
-    )
+      EasyBroker::AUTHORIZATION_HEADER => EasyBroker.configuration.api_key,
+      EasyBroker::COUNTRY_CODE_HEADER => EasyBroker.configuration.country_code
+    ).compact
     @logger = logger
   end
 
@@ -20,11 +21,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 +35,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/configuration.rb

@@ -1,8 +1,9 @@
 class EasyBroker::Configuration
-  attr_accessor :api_key, :api_root_url
+  attr_accessor :api_key, :api_root_url, :country_code
 
   def initialize
     @api_key = nil
+    @country_code = nil
     @api_root_url = EasyBroker::DEFAULT_API_ROOT_URL
   end
 end

data/lib/easy_broker/constants.rb

@@ -5,7 +5,8 @@ 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'
+  COUNTRY_CODE_HEADER  = 'Country-Code'
 end

data/lib/easy_broker/errors.rb

@@ -10,7 +10,7 @@ module EasyBroker
 
   class AuthenticationError < Error
     def initialize(response)
-      super('Invalid API Key or missing permissions', response)
+      super('Invalid API Key or missing configurations', response)
     end
   end
-end
+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/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

@@ -9,9 +9,25 @@ module EasyBroker
         @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/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.5"
+  VERSION = "1.0.2"
 end

data/lib/easy_broker.rb

@@ -14,7 +14,11 @@ 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.5
+  version: 1.0.2
 platform: ruby
 authors:
 - Eric Northam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -130,7 +130,11 @@ 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