immoscout 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d84665a17f30c2eaf4eb162387b47477327c6aeaabe848cd3407c58454164850
+  data.tar.gz: 36645bd40f2b0734d1ea0409f60b752a282e2bb5cdceb0bd7d61658197a4ebbf
+SHA512:
+  metadata.gz: 498747faccb6910c9d27552a6810f0197d7d214fe03299af085524628ec9843de6814ef09bcfe7bb1315a0bd4b0eeea7282e41357f126744626e99294852896f
+  data.tar.gz: 5213e82fc915a05d5e070e513921139d088680cf2cbca7f74697c0bc6b5a080c4d482026be66cab390fbab34f23d5132c4633382c51f029e32b6bd4b6de25f89

data/.editorconfig

@@ -0,0 +1,30 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = true
+
+[*.json]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = 4
+
+[*.sh]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/api
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+spec/test_config\.yml

data/.reek

@@ -0,0 +1,6 @@
+IrresponsibleModule:
+  enabled: false
+ControlParameter:
+  enabled: false
+TooManyStatements:
+  max: 15

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,15 @@
+Documentation:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+  ExcludedMethods:
+    - included
+
+AllCops:
+  Exclude:
+    - "immoscout.gemspec"

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start 'test_frameworks' do
+  add_filter '/vendor/bundle/'
+end

data/.travis.yml

@@ -0,0 +1,20 @@
+sudo: false
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=b3e18bf2298b2b26779929ff953cab53b2e5b791f5f8b0a8023fae0997088da7
+
+language: ruby
+rvm:
+  - 2.5
+  - 2.4
+  - 2.3
+  - 2.2
+
+before_install: gem install bundler -v 1.15.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

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 development@hausgold.de. 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,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in immoscout.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 HAUSGOLD
+
+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,250 @@
+![Immoscout](doc/assets/project.png)
+
+[![Build Status](https://travis-ci.org/hausgold/immoscout.svg?branch=master)](https://travis-ci.org/hausgold/immoscout)
+[![Gem Version](https://badge.fury.io/rb/immoscout.svg)](https://badge.fury.io/rb/immoscout)
+[![Maintainability](https://api.codeclimate.com/v1/badges/bfd4a5c188d5f1aebd60/maintainability)](https://codeclimate.com/github/hausgold/immoscout/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/bfd4a5c188d5f1aebd60/test_coverage)](https://codeclimate.com/github/hausgold/immoscout/test_coverage)
+[![API docs](https://img.shields.io/badge/docs-API-blue.svg)](https://www.rubydoc.info/gems/immoscout)
+
+This gem provides an API wrapper for the [Immobilienscout24 REST
+API](https://api.immobilienscout24.de/our-apis/import-export.html). It provides
+the well known _ActiveRecord-like_ model methods.
+
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Configuration](#configuration)
+  - [Models](#models)
+    - [Real Estates](#real-estates)
+      - [Overview supported actions](#overview-supported-actions)
+      - [Initialize](#initialize)
+      - [Find](#find)
+      - [Create & Update & Destroy](#create--update--destroy)
+      - [Publish & Unpublish](#publish--unpublish)
+      - [Ontop-Placement](#ontop-placement)
+    - [Contact](#contact)
+      - [Overview supported actions](#overview-supported-actions-1)
+    - [Publish](#publish)
+      - [Overview supported actions](#overview-supported-actions-2)
+    - [Attachment (Picture & Document)](#attachment-picture--document)
+      - [Overview supported actions](#overview-supported-actions-3)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'immoscout'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install immoscout
+```
+
+## Usage
+
+### Configuration
+
+```ruby
+Immoscout.configure do |config|
+  config.consumer_key = "key"
+  config.consumer_secret = "secret"
+  config.oauth_token = "token"
+  config.oauth_token_secret = "token_secret"
+  config.use_sandbox = true # default: false
+  config.user_name = "immoscout-user-name" # default: 'me'
+end
+```
+
+### Models
+
+#### Real Estates
+
+Currently supported: `ApartmentBuy`, `HouseBuy`
+
+##### Overview supported actions
+* .find(id)
+* .all
+* .first
+* .last
+* .new(hash)
+* .from_raw(remote_hash_or_json)
+* .create(hash)
+* #save
+* #destroy
+* #publish
+* #unpublish
+* #place(placement_type)
+* #unplace(placement_type)
+
+##### Initialize
+```ruby
+# initialize with hash
+house = Immoscout::Models::HouseBuy.new(title: "test", address: {street: "thestreet"})
+# => #<Immoscout::Models::HouseBuy:0x0055c9fbbc6ea0 @address=#<Immoscout::Models::Parts::Address:0x0055c9fbbc6888 @street="thestreet">, @title="test">
+
+# initialize with attribute writers
+house = Immoscout::Models::HouseBuy.new
+# => #<Immoscout::Models::HouseBuy:0x0055d31f734838>
+house.title = "another title"
+# => "another title"
+
+# access nested attributes
+house.build_address
+# => #<Immoscout::Models::Parts::Address:0x0055c9fbc77d18>
+house.address.street = "another street"
+
+# lookup all allowed first-level attributes
+house.attributes
+# => [:address, :api_search_data, :building_energy_rating_type, ...]
+house.address.attributes
+# => [:city, :house_number, :postcode, :street, ...]
+```
+
+##### Find
+```ruby
+apartment = Immoscout::Models::ApartmentBuy.find('ID')
+# => #<Immoscout::Models::ApartmentBuy:0x0055c9fbfa0648>
+apartment.address.street
+# => 'Orig street name'
+```
+##### Create & Update & Destroy
+```ruby
+apartment = Immoscout::Models::ApartmentBuy.find('ID')
+apartment.address.street = "Changed street"
+apartment.save
+# => #<Immoscout::Models::ApartmentBuy:0x0055c9fbfa0648>
+
+house = Immoscout::Models::HouseBuy.find('9473634')
+house.destroy
+# => #<Immoscout::Models::HouseBuy:0x0055d31f734838>
+```
+
+##### Publish & Unpublish
+```ruby
+apartment = Immoscout::Models::ApartmentBuy.find('ID')
+# => #<Immoscout::Models::ApartmentBuy:0x0055c9fbfa0648>
+apartment.publish
+# => #<Immoscout::Models::Publish:0x0085a2fbfa0688>
+apartment.unpublish
+# => #<Immoscout::Models::Publish:0x00831b2fbfc1234>
+```
+
+##### Ontop-Placement
+```ruby
+# allowed placement types: showcaseplacement, premiumplacement, topplacement
+apartment = Immoscout::Models::ApartmentBuy.find('ID')
+# add premiumplacement
+apartment.place(:premiumplacement)
+# => #<Immoscout::Models::ApartmentBuy:0x0055c9fbfa0648>
+# remove premiumplacement
+apartment.unplace(:premiumplacement)
+# => #<Immoscout::Models::ApartmentBuy:0x0055c9fbfa0648>
+```
+
+#### Contact
+
+##### Overview supported actions
+* .find(id)
+* .all
+* .first
+* .last
+* .new(hash)
+* .from_raw(remote_hash_or_json)
+* .create(hash)
+* #save
+* #destroy
+
+```ruby
+contact = Immoscout::Models::Contact.new firstname: "John", lastname: "Doe"
+# => #<Immoscout::Models::Contact:0x0055c9fb889878 @firstname="John", @lastname="Doe">
+contact.email = "john.doe@example.com"
+contact.salutation = "MALE"
+contact.save
+# => #<Immoscout::Models::Contact:0x0055c9fb889878 @email="john.doe@example.com", @firstname="John", @lastname="Doe", @salutation="MALE">
+```
+
+#### Publish
+
+If you don't like or can't use the `#publish` and `#unpublish` methods defined for realestate models, you can create the `Publish` instance yourself.
+
+##### Overview supported actions
+* .new(hash)
+* .from_raw(remote_hash_or_json)
+* #save
+* #destroy
+
+```ruby
+# NOTE: publish_channel#id = 10000 => publish on immobilienscout24
+publish = Immoscout::Models::Publish.new real_estate: { id: "ID" }, publish_channel: {id: 10_000}
+
+publish.save # published!
+# => #<Immoscout::Models::Publish:0x0055c9faea1fb8>
+publish.destroy # unpublished!
+# => #<Immoscout::Models::Publish:0x0055c9faea1fb8>
+```
+
+#### Attachment (Picture & Document)
+
+##### Overview supported actions
+* .new(hash)
+* .from_raw(remote_hash_or_json)
+* #save
+* #destroy
+
+```ruby
+picture = Immoscout::Models::Picture.new title: "Badezimmer", title_picture: true, floor_plan: false
+picture.file = File.open("the/path/to/the/file.jpg") #
+picture.attachable = Immoscout::Models::HouseBuy.last # you can also pass the ID
+
+picture.save # attachment upload!
+# => #<Immoscout::Models::Picture:0x0055c9faea1fb8>
+
+picture.destroy # attachment destroy!
+# => #<Immoscout::Models::Picture:0x0055c9faea1fb8>
+```
+
+## 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 run specs against the immobilienscout24 sandbox api, you need to create some
+keys and tokens. Copy the `spec/test_config.yml.example` to
+`spec/test_config.yml` and fill in your generated values.
+
+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/hausgold/immoscout. 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](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Immoscout project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/hausgold/immoscout/blob/master/CODE_OF_CONDUCT.md).