rzoopla 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b34d2b535148601f7ff4eb2e3fb4c91caf00556
+  data.tar.gz: 254d355bd399f74c3708782d98ba5616ccbbf6d3
+SHA512:
+  metadata.gz: 1ee40c4dd967aae3a763e948d1b51f6a06b610a3fc3b4546482f6fb7a5141c7735358fdf639c1cc7fb302616df8e0eef3b1c44a04bb6789e0f63361a73181984
+  data.tar.gz: 02dae2e83184c814e20b373cc932b7e60ddbc5d79dd30d30eb030f2af31812c3f619794453fb777ab25b1dc816a8f25c2f3d7528b207af196c3f2e9eb46b3687

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Style/Documentation:
+  Enabled: false
+Style/BlockDelimiters:
+  Enabled: false
+Metrics/LineLength:
+  Max: 90

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rzoopla.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# RZoopla
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rzoopla'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rzoopla
+
+## Usage
+
+    RZoopla.configure do |config|
+      config.api_key = ENV['ZOOPLA_API_KEY']
+    end
+
+    RZoopla::Listings.where(
+      area: 'Edinburgh'
+      radius: 0.1,
+      order_by: 'age',
+      maximum_beds: 2,
+      listing_status: 'sale',
+      include_sold: 0
+    )
+
+## Contributing
+
+1. Fork it ( https://github.com/Omer/rzoopla/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rzoopla'
+
+# 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

data/bin/setup

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

data/lib/rzoopla.rb

@@ -0,0 +1,24 @@
+require 'net/http'
+require 'cgi'
+require 'json'
+require 'rzoopla/version'
+require 'rzoopla/utils'
+require 'rzoopla/client'
+require 'rzoopla/base_collection'
+require 'rzoopla/base_model'
+require 'rzoopla/resources'
+
+module RZoopla
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key
+  end
+end

data/lib/rzoopla/base_collection.rb

@@ -0,0 +1,52 @@
+module RZoopla
+  class BaseCollection
+    ATTRIBUTES = [:result_count, :page_number, :page_size, :results]
+    DEFAULT_PAGINATION_OPTIONS = {
+      page_number: 1,
+      page_size: 10
+    }
+
+    attr_reader(*ATTRIBUTES)
+
+    include Enumerable
+
+    def initialize(options = {})
+      ATTRIBUTES.each do |attr|
+        instance_variable_set("@#{attr}", options[attr])
+      end
+    end
+
+    def each(&block)
+      @results.each(&block)
+    end
+
+    def size
+      @results.size
+    end
+
+    def [](index)
+      @results[index]
+    end
+
+    def self.where(options = {})
+      opt = DEFAULT_PAGINATION_OPTIONS.clone.merge(options)
+      result = RZoopla::Utils.symbolize_keys(RZoopla::Client.get(end_point, opt))
+      new(
+        page_number: opt[:page_number],
+        page_size: opt[:page_size],
+        result_count: result[:result_count],
+        results: extract_results(result)
+      )
+    end
+
+    class << self
+      private
+
+      def extract_results(results)
+        results[results_field].map { |result| model.new(result) }
+      end
+
+      attr_accessor :end_point, :results_field, :model
+    end
+  end
+end

data/lib/rzoopla/base_model.rb

@@ -0,0 +1,23 @@
+module RZoopla
+  class BaseModel
+    def initialize(options = {})
+      self.class.attributes.each do |attribute|
+        instance_variable_set("@#{attribute}", options[attribute])
+
+        self.class.send(:define_method, attribute) do
+          instance_variable_get("@#{attribute}")
+        end
+      end
+    end
+
+    def to_hash
+      Hash[*instance_variables.flat_map { |var|
+        [var.to_s.delete('@'), instance_variable_get(var)]
+      }]
+    end
+
+    class << self
+      attr_accessor :attributes
+    end
+  end
+end

data/lib/rzoopla/client.rb

@@ -0,0 +1,27 @@
+module RZoopla
+  module Client
+    class << self
+      BASE_URI = 'http://api.zoopla.co.uk/api/v1/'
+
+      def get(end_point, options = {})
+        options = { api_key: RZoopla.configuration.api_key }.merge(options)
+        uri = URI.parse([BASE_URI, end_point, '.json', parse_params(options)].join)
+        response = Net::HTTP.get_response(uri)
+        if response.code == '200'
+          JSON.parse(response.body)
+        else
+          fail "#{response.message} (#{response.code})"
+        end
+      end
+
+      private
+
+      def parse_params(params)
+        return '' if params.empty?
+        '?' + params.map { |k, v|
+          "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+        }.join('&')
+      end
+    end
+  end
+end

data/lib/rzoopla/resources.rb

@@ -0,0 +1,2 @@
+require 'rzoopla/resources/listing'
+require 'rzoopla/resources/listings'

data/lib/rzoopla/resources/listing.rb

@@ -0,0 +1,13 @@
+module RZoopla
+  class Listing < RZoopla::BaseModel
+    self.attributes = [
+      :num_floors, :listing_status, :num_bedrooms, :latitude,
+      :agent_address, :property_type, :longitude, :thumbnail_url, :description,
+      :post_town, :details_url, :short_description, :outcode, :county, :price,
+      :listing_id, :image_caption, :status, :agent_name, :num_recepts,
+      :country, :displayable_address, :first_published_date, :price_modifier,
+      :floor_plan, :street_name, :num_bathrooms, :price_change, :agent_logo,
+      :agent_phone, :image_url, :last_published_date
+    ]
+  end
+end

data/lib/rzoopla/resources/listings.rb

@@ -0,0 +1,7 @@
+module RZoopla
+  class Listings < RZoopla::BaseCollection
+    self.end_point = 'property_listings'
+    self.results_field = :listing
+    self.model = RZoopla::Listing
+  end
+end

data/lib/rzoopla/utils.rb

@@ -0,0 +1,39 @@
+module RZoopla
+  module Utils
+    class << self
+      def pluck(hash, *args)
+        Hash[hash.find_all { |k, _| args.include?(k) }]
+      end
+
+      def symbolize_keys(obj)
+        case obj
+        when Hash  then symbolize_keys_hash(obj)
+        when Array then symbolize_keys_array(obj)
+        else            obj
+        end
+      end
+
+      private
+
+      def symbolize_keys_hash(hash)
+        hash.each_with_object({}) { |(key, value), result|
+          result[key.respond_to?(:to_sym) ? key.to_sym : key] = \
+            case value
+            when Hash  then symbolize_keys_hash(value)
+            when Array then symbolize_keys_array(value)
+            else value
+            end
+        }
+      end
+
+      def symbolize_keys_array(array)
+        array.map { |el|
+          case el
+          when Hash then symbolize_keys_hash(el)
+          else el
+          end
+        }
+      end
+    end
+  end
+end

data/lib/rzoopla/version.rb

@@ -0,0 +1,3 @@
+module RZoopla
+  VERSION = '0.1.0'
+end

data/lib/zoopla/base_collection.rb

@@ -0,0 +1,52 @@
+module RZoopla
+  class BaseCollection
+    ATTRIBUTES = [:result_count, :page_number, :page_size, :results]
+    DEFAULT_PAGINATION_OPTIONS = {
+      page_number: 1,
+      page_size: 10
+    }
+
+    attr_reader(*ATTRIBUTES)
+
+    include Enumerable
+
+    def initialize(options = {})
+      ATTRIBUTES.each do |attr|
+        instance_variable_set("@#{attr}", options[attr])
+      end
+    end
+
+    def each(&block)
+      @results.each(&block)
+    end
+
+    def size
+      @results.size
+    end
+
+    def [](index)
+      @results[index]
+    end
+
+    def self.where(options = {})
+      opt = DEFAULT_PAGINATION_OPTIONS.clone.merge(options)
+      result = RZoopla::Utils.symbolize_keys(RZoopla::Client.get(end_point, opt))
+      new(
+        page_number: opt[:page_number],
+        page_size: opt[:page_size],
+        result_count: result[:result_count],
+        results: extract_results(result)
+      )
+    end
+
+    class << self
+      private
+
+      def extract_results(results)
+        results[results_field].map { |result| model.new(result) }
+      end
+
+      attr_accessor :end_point, :results_field, :model
+    end
+  end
+end

data/lib/zoopla/base_model.rb

@@ -0,0 +1,23 @@
+module RZoopla
+  class BaseModel
+    def initialize(options = {})
+      self.class.attributes.each do |attribute|
+        instance_variable_set("@#{attribute}", options[attribute])
+
+        self.class.send(:define_method, attribute) do
+          instance_variable_get("@#{attribute}")
+        end
+      end
+    end
+
+    def to_hash
+      Hash[*instance_variables.flat_map { |var|
+        [var.to_s.delete('@'), instance_variable_get(var)]
+      }]
+    end
+
+    class << self
+      attr_accessor :attributes
+    end
+  end
+end

data/lib/zoopla/client.rb

@@ -0,0 +1,27 @@
+module RZoopla
+  module Client
+    class << self
+      BASE_URI = 'http://api.zoopla.co.uk/api/v1/'
+
+      def get(end_point, options = {})
+        options = { api_key: RZoopla.configuration.api_key }.merge(options)
+        uri = URI.parse([BASE_URI, end_point, '.json', parse_params(options)].join)
+        response = Net::HTTP.get_response(uri)
+        if response.code == '200'
+          JSON.parse(response.body)
+        else
+          fail "#{response.message} (#{response.code})"
+        end
+      end
+
+      private
+
+      def parse_params(params)
+        return '' if params.empty?
+        '?' + params.map { |k, v|
+          "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
+        }.join('&')
+      end
+    end
+  end
+end

data/lib/zoopla/utils.rb

@@ -0,0 +1,39 @@
+module RZoopla
+  module Utils
+    class << self
+      def pluck(hash, *args)
+        Hash[hash.find_all { |k, _| args.include?(k) }]
+      end
+
+      def symbolize_keys(obj)
+        case obj
+        when Hash  then symbolize_keys_hash(obj)
+        when Array then symbolize_keys_array(obj)
+        else            obj
+        end
+      end
+
+      private
+
+      def symbolize_keys_hash(hash)
+        hash.each_with_object({}) { |(key, value), result|
+          result[key.respond_to?(:to_sym) ? key.to_sym : key] = \
+            case value
+            when Hash  then symbolize_keys_hash(value)
+            when Array then symbolize_keys_array(value)
+            else value
+            end
+        }
+      end
+
+      def symbolize_keys_array(array)
+        array.map { |el|
+          case el
+          when Hash then symbolize_keys_hash(el)
+          else el
+          end
+        }
+      end
+    end
+  end
+end

data/rzoopla.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rzoopla/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rzoopla'
+  spec.version       = RZoopla::VERSION
+  spec.authors       = ['Omer Jakobinsky']
+  spec.email         = ['omer@jakobinsky.com']
+
+  spec.summary       = 'A Ruby wrapper for the Zoopla API.'
+  spec.description   = 'A work in progress Ruby wrapper for the Zoopla API.'
+  spec.homepage      = 'https://github.com/Omer/rzoopla'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f|
+    f.match(%r{^(test|spec|features)/})
+  }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.30'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rzoopla
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Omer Jakobinsky
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+description: A work in progress Ruby wrapper for the Zoopla API.
+email:
+- omer@jakobinsky.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rzoopla.rb
+- lib/rzoopla/base_collection.rb
+- lib/rzoopla/base_model.rb
+- lib/rzoopla/client.rb
+- lib/rzoopla/resources.rb
+- lib/rzoopla/resources/listing.rb
+- lib/rzoopla/resources/listings.rb
+- lib/rzoopla/utils.rb
+- lib/rzoopla/version.rb
+- lib/zoopla/base_collection.rb
+- lib/zoopla/base_model.rb
+- lib/zoopla/client.rb
+- lib/zoopla/utils.rb
+- rzoopla.gemspec
+homepage: https://github.com/Omer/rzoopla
+licenses: []
+metadata: {}
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper for the Zoopla API.
+test_files: []