easy_broker 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e776eb6519e1c3bfcb77a951c47b78d89d425665c9400149ed75b792e6fa7cef
+  data.tar.gz: 7297f553a3f882198d86cc1857750795fefb76a2afdddb3a8fefd15f2a704d74
+SHA512:
+  metadata.gz: 19205db9c8dde2f1e2024ddc2c1be72e2bdee469dd6a5ff7403fd7f65ac21d3714e4599fb40ac2c5e4f52e4394d768f285ead5bf1260bd8f6f22a190515d90e9
+  data.tar.gz: 3264d842b5195beca8060faab72b2bdb53991680a0230877ab9ce01eaf333c229590a5e62c359f9019e7b259b4ff8accdfce6d21c5cfe2e533a0344ddd80411d

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+/vendor
+.DS_Store
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## 0.1.1
+* Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in easy_broker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Eric Northam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# EasyBroker
+
+A gem that makes it easy to work with the [EasyBroker API](https://api.easybroker.com/api/playground).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_broker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_broker
+
+## Usage
+
+Configure the gem with your application ID and secret key. This is the first draft which
+just offers basic support for finding and searching properties.
+
+```ruby
+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/'
+end
+```
+
+Then in your app use the _client_ to access the API.
+
+```ruby
+client = EasyBroker.client
+
+client.properties.find('EB-123')
+results = client.properties.search # results is an enumerator
+
+# Print the first page of up to 20 results
+results.each do |property|
+  puts property.public_id
+end
+
+# Or use find_each to automatically iterate over all the results on each page
+results.find_each do |property|
+  puts property.public_id
+end
+
+# Search for only published properties
+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)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/easybroker/easy_broker_api.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easy_broker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easy_broker.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "easy_broker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_broker"
+  spec.version       = EasyBroker::VERSION
+  spec.authors       = ["Eric Northam"]
+  spec.email         = ["eric@northam.us"]
+
+  spec.summary       = %q{A gem to work with EasyBroker's API}
+  spec.homepage      = "https://github.com/easybroker/easybroker_gem/"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.18"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "mocha"
+end

data/lib/easy_broker.rb

@@ -0,0 +1,29 @@
+require 'httparty'
+
+require 'easy_broker/version'
+require 'easy_broker/constants'
+require 'easy_broker/errors'
+require 'easy_broker/configuration'
+require 'easy_broker/api_client'
+require 'easy_broker/public_client'
+require 'easy_broker/paginated_response'
+require 'easy_broker/query'
+require 'easy_broker/properties'
+
+module EasyBroker
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.api_client(logger: nil)
+    EasyBroker::ApiClient.new(logger: logger)
+  end
+
+  def self.client(logger: nil)
+    EasyBroker::PublicClient.new(logger: logger)
+  end
+end

data/lib/easy_broker/api_client.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+class EasyBroker::ApiClient
+  include HTTParty
+  
+  format :json
+
+  attr_reader :logger
+
+  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
+    )
+    @logger = logger
+  end
+
+  def get(path, query: {})
+    send_request(:get, path, query: query)
+  end
+
+  def post(path, query: {}, body: {})
+    send_request(:post, path, query: query, body: body)
+  end
+
+  def put(path, query: {}, body: {})
+    send_request(:put, path, query: query, body: body)
+  end
+
+  def delete(path, query: {})
+    send_request(:delete, path, query: query)
+  end
+
+  private
+
+  def send_request(verb, path = '', params = {})
+    query = params[:query] || params['query'] || {}
+
+    self.class.send(verb, path, params.merge(query)).tap do |response|
+      check_errors(response)
+      logger&.log response
+    end
+  end
+
+  def check_errors(response)
+    raise EasyBroker::AuthenticationError.new(response) if response.code == 401
+  end
+end

data/lib/easy_broker/configuration.rb

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

data/lib/easy_broker/constants.rb

@@ -0,0 +1,10 @@
+module EasyBroker
+  USER_AGENT = "EasyBroker-%s" % VERSION
+  DEFAULT_HEADERS = {
+    'Content-Type' => 'application/json',
+    'Accept' => 'application/json',
+    'User-Agent' => USER_AGENT
+  }
+  DEFAULT_API_ROOT_URL = 'https://www.easybroker.com/api/v1'
+  AUTHORIZATION_HEADER = 'X-Authorization'
+end

data/lib/easy_broker/errors.rb

@@ -0,0 +1,16 @@
+module EasyBroker
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(message, response)
+      @response = response
+      super(message)
+    end
+  end
+
+  class AuthenticationError < Error
+    def initialize(response)
+      super('Invalid API Key or missing permissions', response)
+    end
+  end
+end

data/lib/easy_broker/paginated_response.rb

@@ -0,0 +1,54 @@
+class EasyBroker::PaginatedResponse
+  include Enumerable
+
+  attr_reader :query, :response
+
+  def initialize(query)
+    @query = query
+    @response = query.get
+  end
+
+  def total
+    pagination&.total
+  end
+
+  def limit
+    pagination&.limit
+  end
+
+  def page
+    pagination&.page
+  end
+
+  def next_page
+    next_page_number = page.nil? ? 1 : page + 1
+
+    if next_page_number * limit <= total
+      @response = query.get(next_page_number)
+    end
+  end
+
+  def find_each
+    return self.to_enum(:find_each) unless block_given?
+    loop do
+      each do |object|
+        yield object
+      end
+      break unless next_page
+    end 
+  end
+
+  def each
+    return response.content.to_enum(:each) unless block_given?
+
+    response.content.each do |object|
+      yield object
+    end
+  end
+
+  private
+
+  def pagination
+    response&.pagination
+  end
+end

data/lib/easy_broker/properties.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class EasyBroker::Properties
+  ENDPOINT = '/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/public_client.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class EasyBroker::PublicClient
+  attr_reader :api_client
+
+  def initialize(logger: nil)
+    @api_client = EasyBroker::ApiClient.new(logger: logger)
+  end
+
+  def properties
+    EasyBroker::Properties.new(api_client)
+  end
+end

data/lib/easy_broker/query.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class EasyBroker::Query
+  attr_reader :api_client, :endpoint, :query_params
+
+  def initialize(api_client, endpoint, query_params)
+    @api_client = api_client
+    @endpoint = endpoint
+    @query_params = query_params
+  end
+
+  def get(page = 1)
+    query_params[:page] = page
+    response = api_client.get(endpoint, query: query_params)
+    JSON.parse(response.body, object_class: OpenStruct)
+  end
+end

data/lib/easy_broker/version.rb

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

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: easy_broker
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Eric Northam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eric@northam.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_broker.gemspec
+- lib/easy_broker.rb
+- lib/easy_broker/api_client.rb
+- lib/easy_broker/configuration.rb
+- lib/easy_broker/constants.rb
+- lib/easy_broker/errors.rb
+- lib/easy_broker/paginated_response.rb
+- lib/easy_broker/properties.rb
+- lib/easy_broker/public_client.rb
+- lib/easy_broker/query.rb
+- lib/easy_broker/version.rb
+homepage: https://github.com/easybroker/easybroker_gem/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/easybroker/easybroker_gem/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A gem to work with EasyBroker's API
+test_files: []