domain_com_au 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: afb5730e23debc3d9f25d49991eed73c47582a87
+  data.tar.gz: 81b69c7c3be6a1a4b76ea0846c390ff4935fd57c
+SHA512:
+  metadata.gz: 89b98b2687cf3ee450ef39f441377e7a65edb3b5d8864647d879c6a2875f1de2262ab576080f5a3cd5763a0ec490afd30cdab555eda599d83e43e6015647e7c5
+  data.tar.gz: 8fe37e3573ffb6cf909209dc0255263c09c0529dc5fda399d842fdaf9b5c3144c375609a76aadf6468c8b5555516f60dd83eb0eba6df00f42df8d38083494bba

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+**/*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joshua@wilkosz.com.au. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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 domain_com_au.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    domain_com_au (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  domain_com_au!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joshua Wilkosz
+
+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,43 @@
+# DomainComAu
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/domain_com_au`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'domain_com_au'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install domain_com_au
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/domain_com_au. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DomainComAu project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/domain_com_au/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require "bundler/setup"
+require "domain_com_au"
+require "pry"
+
+# 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/domain_com_au.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "domain_com_au/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "domain_com_au"
+  spec.version       = DomainComAu::VERSION
+  spec.authors       = ["Joshua Wilkosz"]
+  spec.email         = ["joshua@wilkosz.com.au"]
+  spec.summary       = %q{Ruby client for domain.com.au api}
+  spec.description   = %q{Provides wrapper class for retrieving domain.com.au resources}
+  spec.homepage      = "https://github.com/wilkosz/domain_com_au"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

data/lib/domain_com_au/client.rb

@@ -0,0 +1,20 @@
+require 'domain_com_au/http_client'
+require 'domain_com_au/domain_listing'
+
+class Client
+  def initialize(client_id, client_secret)
+    @http_client = HttpClient.new(client_id, client_secret)
+  end
+
+  def get_token
+    @http_client.auth_token
+  end
+
+  def search_listings(type, params={})
+    DomainListing.index(@http_client, type, params)
+  end
+
+  def show_listing(id)
+    DomainListing.show(@http_client, id)
+  end
+end

data/lib/domain_com_au/constants.rb

@@ -0,0 +1,5 @@
+module Constants
+  # Defaults
+  BASE_AUTH_URL = 'https://auth.domain.com.au/v1'
+  BASE_API_URL = 'https://api.domain.com.au/v1'
+end

data/lib/domain_com_au/domain_listing.rb

@@ -0,0 +1,24 @@
+require 'domain_com_au/constants'
+require 'json'
+
+module DomainListing
+
+  def self.index(http_client, type='residential', params={})
+    url = "#{Constants::BASE_API_URL}/listings/#{type}/_search"
+    uri = URI(url)
+    check_response_and_return(http_client.post(uri,params))
+  end
+
+  def self.show(http_client, id)
+    url = "#{Constants::BASE_API_URL}/listings/#{id}"
+    uri = URI(url)
+    check_response_and_return(http_client.get(uri))
+  end
+
+  private
+
+  def self.check_response_and_return(res)
+    raise StandardError.new("domain.com.au error: res.code #{res.code}, with res.body #{res.body}") unless res.code && res.body
+    JSON.parse(res.body)
+  end
+end

data/lib/domain_com_au/http_client.rb

@@ -0,0 +1,99 @@
+require 'domain_com_au/constants'
+require 'net/http'
+require 'json'
+require 'base64'
+require 'time'
+
+class HttpClient
+  attr_accessor :auth_token
+
+  def initialize(client_id, client_secret)
+    @client_id = client_id
+    @client_secret = client_secret
+    @headers = {
+      'content-type': 'application/json'
+    }
+    # @auth_action = true
+    authorize
+  end
+
+  def post(uri, params={}, headers={})
+    authorize if @auth_token && is_token_expired?
+    check_uri(uri)
+    req = Net::HTTP::Post.new(uri)
+    set_headers(req, headers)
+    set_body(req, params)
+    http_response(uri, req)
+  end
+
+  def get(uri, headers={})
+    authorize if @auth_token && is_token_expired?
+    check_uri(uri)
+    req = Net::HTTP::Get.new(uri)
+    set_headers(req, headers)
+    http_response(uri, req)
+  end
+
+  private
+
+  def is_token_expired?
+    @auth_expiry - 60 <= Time.now # add request buffer
+  end
+
+  def check_uri(uri)
+    raise ArgumentError.new('Uri cannot be nil') unless uri
+  end
+
+  def set_headers(req, headers)
+    req['authorization'] = "#{@auth_type} #{@auth_token}" if @auth_token && @auth_type
+    @headers.each { |key, value| req[key.to_s] = value }
+    headers.each { |key, value| req[key.to_s] = value } if headers.class == Hash
+  end
+
+  def set_body(req, params)
+    req.body = case req['content-type']
+      when 'application/x-www-form-urlencoded' then
+        URI.encode_www_form(params)
+      when 'application/json' then
+        params.to_json
+      else nil
+      end
+  end
+
+  def http_response(uri, req)
+    return unless uri.hostname && uri.port
+    res = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') { |http| http.request(req) }
+    # if [401,403].include?(res.code.to_i) && @auth_action
+    #   raise StandardError.new("Couldn't Authenticate, res.body: #{res.body}, res.code: #{res.code}")
+    # elsif [401,403].include?(res.code.to_i)
+    #   authorize && @auth_action = true
+    #   set_headers(req, {})
+    #   res = http_response(uri, req)
+    # end
+    # @auth_action = false
+    res
+  end
+
+  def authorize
+    uri = URI("#{Constants::BASE_AUTH_URL}/connect/token")
+    base_64_credentials = Base64.strict_encode64("#{@client_id}:#{@client_secret}")
+    params = {
+      grant_type: "client_credentials",
+      scope: "api_listings_read api_agencies_read"
+    }
+    headers = {
+      'authorization': "basic #{base_64_credentials}",
+      'content-type': "application/x-www-form-urlencoded"
+    }
+    time_now = Time.now
+    res = post(uri, params, headers)
+    if res.body && res.code.to_i == 200
+      body = JSON.parse(res.body)
+      @auth_token = body['access_token']
+      @auth_type = body['token_type']
+      @auth_expiry = time_now + body['expires_in']
+    else
+      raise ArgumentError.new("Domain Auth API didn't return a token, body: #{res.body}, status: #{res.code}")
+    end
+  end
+end

data/lib/domain_com_au/version.rb

@@ -0,0 +1,3 @@
+module DomainComAu
+  VERSION = "0.1.0"
+end

data/lib/domain_com_au.rb

@@ -0,0 +1,8 @@
+require "domain_com_au/client"
+
+module DomainComAu
+  def self.create_client(client_id=nil, client_secret=nil)
+    raise ArgumentError.new('Client ID and Client Secret not provided') unless client_id && client_secret
+    Client.new(client_id, client_secret)
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: domain_com_au
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Wilkosz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Provides wrapper class for retrieving domain.com.au resources
+email:
+- joshua@wilkosz.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- domain_com_au.gemspec
+- lib/domain_com_au.rb
+- lib/domain_com_au/client.rb
+- lib/domain_com_au/constants.rb
+- lib/domain_com_au/domain_listing.rb
+- lib/domain_com_au/http_client.rb
+- lib/domain_com_au/version.rb
+homepage: https://github.com/wilkosz/domain_com_au
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Ruby client for domain.com.au api
+test_files: []