This repository has been archived by the owner. It is now read-only.
[DEPRECATED] Ruby wrapper for the Justimmo API (mirror)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
examples
lib
locales
spec
.editorconfig
.gitignore
.gitlab-ci.yml
.rspec
.rubocop.yml
.simplecov
Gemfile
LICENSE
README.md
Rakefile
justimmo_client.gemspec
notes.md

README.md

pipeline status coverage report Codacy Badge Inline docs

Justimmo Client

Ruby client for the Justimmo REST API.

Dependencies

  • Ruby 2.3+

Installation

Add this line to your application's Gemfile:

gem "justimmo_client"

And then execute:

$ bundle install

Or install it yourself as:

$ gem install justimmo_client

Usage Example (Rails)

config/initializers/justimmo.rb

JustimmoClient.configure do |config|
  config.username = "your-username"
  config.password = "your_password"
  config.cache    = ActiveSupport::Cache.lookup_store(:memory_store)
end

app/controllers/realty_controller.rb

class RealtyController < ApplicationController
  def index
    @realties = JustimmoClient.realties(zip_code: 6020, limit: 5)
  end
end

For other examples see examples.

Development

After checking out the repo, run bin/setup to install dependencies. Then, put your user credentials into a .env file and run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

Contributing

Bug reports and merge requests are welcome on GitLab.

License

The gem is available as open source under the terms of the MIT License.

Check the LICENSE file for more information.