street_easy 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a328e46dc15fb05c26f257422e040fa5dde4aa8d
-  data.tar.gz: 899fabaa26d9946b0a6edb93d956fe9d3e164417
+  metadata.gz: 0f91bc2036044cd7a42439fa7b9a9f2b2c1f93ba
+  data.tar.gz: a12321d5522f71e1dc1f61662f275b1a08559c8f
 SHA512:
-  metadata.gz: 66ff0e28b4f8a21ab8b2c20507443cb71ae06e30199f1f3d45dfaacd577049ad1a5030dfdb11003c2dbf6b49128f9841f6e25852980f80b7afe75e1ae8dd79f9
-  data.tar.gz: a87aeda7fb2cb2f0cbaf764a658e2b3b50b15d6a03a076f2bfd9f429d7f10811c2301fa6f0ae7d9211d590a1fce0135f88ebdd45420febde640a141caa67ede1
+  metadata.gz: 11d338eb2ffd03abd65f33c8ae2974a55dc89d5a716a4059de4638af018234b2a4d685e978273d6884d5348325779794049abb4690b10a99cac4d455b27a6518
+  data.tar.gz: 4dc52e8804cfef54a1f5c9f7796d7ab0e6c4740cfb5904effda95249dd6a753417c123efccd79b1f4fa47e219d305f26ea1fc109550912028f771fd1c9f6fbdf

data/README.md

@@ -1,6 +1,11 @@
-# StreetEasy
+# StreetEasy API Gem
+
+## Description
+
+A little gem tha integrates with the Street Easy API (beta).
+
+API Documentation available [here](http://streeteasy.com/api/info).
 
-TODO: Write a gem description
 
 ## Installation
 
@@ -16,13 +21,199 @@ Or install it yourself as:
 
     $ gem install street_easy
 
-## Usage
+## Set Up
+
+First, register for an API key [here](http://streeteasy.com/api/info).
+
+Then, place this code somewhere in your ruby environment.
+
+    require 'street_easy'
+
+add your API key to the client:
+
+    StreetEasy::Client.api_key = 'your_api_key'
+
+## Property
+
+The `StreatEasy::Property` object has the following methods:
+
+* .rentals
+* .sales
+* .order(order_type)
+* .neighborhoods(list_of_neighborhoods)
+* .options(list_of_options)
+* .limit(int)
+* .all
+
+
+### Examples
+* return the `200` `:most_expensive` `rentals` in all of `'nyc'` (note, the API maxes out at 200)
+```ruby
+properties = StreetEasy::Property.all
+# or
+properties = StreetEasy::Property.rentals.all
+# or
+properties = StreetEasy::Property.rentals.order(:most_expensive).all
+```
+* return the `200` `:most_expensive` `sales` in all of `'nyc'` (note, the API maxes out at 200)
 
-TODO: Write usage instructions here
+```ruby
+properties = StreetEasy::Property.sales.all
+#or
+properties = StreetEasy::Property.sales.order(:most_expensive).all
+```
+* return the `12` `:least_expensive` `rentals` in all of `'nyc'`.
+
+```ruby
+properties = StreetEasy::Property.order(:least_expensive).limit(12)
+```
+
+* return the `30` `:least_expensive` `rentals` in `'soho'`.
+```ruby
+properties = StreetEasy::Property.neighborhoods('soho').order(:least_expensive).limit(30)
+```
+* return the `newest` `rentals` in both `'soho'` AND `'murray-hill'` (limit 200)
+```ruby
+properties = StreetEasy::Property.neighborhoods('soho', 'murray-hill').order(:newest).all
+# or
+properties = StreetEasy::Property.neighborhoods(['soho', 'murray-hill']).order(:newest).all
+```
+
+* return the `30` `:least_expensive` `sales` in `'soho'`, `'murray hill'`, and the `'lower-east-side'`, but only return their `:price`, `:area_name`, `:description`, and `:floorplan`
+```ruby
+properties = StreetEasy::Property.sales
+  .neighborhoods('soho', 'murray-hill', 'lower-east-side')
+  .options(:price, :area_name, :description, :floorplan)
+  .order(:least_expensive)
+  .limit(30)
+```
+
+### full list of neighborhoods:
+```ruby
+  'battery-park-city'
+  'chelsea'
+  'west-chelsea'
+  'chinatown'
+  'two-bridges'
+  'civic-center'
+  'east-village'
+  'financial-district'
+  'fulton/seaport'
+  'flatiron'
+  'nomad'
+  'gramercy-park'
+  'greenwich-village'
+  'noho'
+  'little-italy'
+  'lower-east-side'
+  'nolita'
+  'soho'
+  'stuyvesant-town/pcv'
+  'tribeca'
+  'west-village'
+  'all-midtown'
+  'central-park-south'
+  'midtown'
+  'midtown-east'
+  'kips-bay'
+  'murray-hill'
+  'sutton-place'
+  'turtle-bay'
+  'beekman'
+  'midtown-south'
+  'midtown-west'
+  'roosevelt-island'
+  'all-upper-east-side'
+  'carnegie-hill'
+  'lenox-hill'
+  'upper-carnegie-hill'
+  'upper-east-side'
+  'yorkville'
+  'all-upper-west-side'
+  'lincoln-square'
+  'manhattan-valley'
+  'morningside-heights'
+  'upper-west-side'
+  'all-upper-manhattan'
+  'central-harlem'
+  'east-harlem'
+  'hamilton-heights'
+  'inwood'
+  'manhattanville'
+  'washington-heights'
+  'fort-george'
+  'hudson-heights'
+  'west-harlem'
+```
+
+
+### list of .order options
+```ruby
+  :most_expensive  # default
+  :least_expensive
+  :newest
+```
+
+### list of .option parameters
+
+```ruby
+      
+  # default attributes
+  :title
+  :area_name
+  :price
+  :bedrooms
+  :bathrooms
+  :size_sqft
+  :url
+  :medium_image_uri
+
+  # additional attributes
+  :source_label
+  :clean_address
+  :description
+  :half_baths
+  :rooms_description
+  :addr_street
+  :addr_unit
+  :normalized_addr_unit
+  :addr_city
+  :addr_lat
+  :addr_lon
+  :size_sqft_num
+  :lot_size
+  :size_description
+  :ppsf
+  :ppsf_num
+  :ppsf_description
+  :created_at
+  :unit_type
+  :unit_type_label
+  :status
+  :price_cur
+  :floorplan
+  :open_house_start
+  :open_house_end
+  :sourceid
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/street_easy/fork )
+PLEASE CONTRIBUTE!  This is my first ruby gem, and my first contribution to the open source movement! Therefore, there's a lot of room for improvement :)
+
+TODO:
+* tests (oh the travis-ci!)
+* error handling
+* refactor
+* add other classes like `StreetEasy::NeighborhoodData`, `StreetEasy::Geo`, and others.
+
+THOUGHTS:
+* extract `StreetEasy::Property` into `StreetEasy::Property::Rental` and `StreetEasy::Property::Sale`?
+* return objects instead of hashes?
+* add a `.first` method? Other methods?
+* don't implement method chaining?
+
+1. Fork it ( https://github.com/cblokker/street_easy/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`)

data/lib/street_easy/client.rb

@@ -0,0 +1,39 @@
+module StreetEasy
+  class Client
+    BASE_URI = "http://www.streeteasy.com/nyc/api/"
+
+    def self.api_key
+      @api_key
+    end
+
+    def self.api_key=(key)
+      @api_key = key
+    end
+
+    def self.construct_url(query)
+      uri = URI(
+        "#{BASE_URI}" +
+        "#{query[:property_type]}/" +
+        "search?criteria=" +
+          "area=#{query[:neighborhoods]}&" +
+          "limit=#{query[:limit]}&" +
+          "order=#{query[:order]}&" +
+          "key=#{@api_key}&" +
+          "format=json"
+      )
+    end
+
+    def self.construct_url(query)
+      uri = URI(
+        "#{BASE_URI}" +
+        "#{query[:property_type]}/" +
+        "search?criteria=" +
+          "area=#{query[:neighborhoods]}&" +
+          "limit=#{query[:limit]}&" +
+          "order=#{query[:order]}&" +
+          "key=#{@api_key}&" +
+          "format=json"
+      )
+    end
+  end
+end

data/lib/street_easy/property.rb

@@ -0,0 +1,129 @@
+require 'open-uri'
+require 'json'
+
+module StreetEasy
+  class Property < Client
+    @property_type = 'rentals'
+    @options = [
+      :title,
+      :area_name,
+      :price,
+      :bedrooms,
+      :bathrooms,
+      :size_sqft,
+      :url
+    ]
+
+
+    OPTIONS = [
+      :title,
+      :area_name,
+      :price,
+      :bedrooms,
+      :bathrooms,
+      :size_sqft,
+      :url,
+      :medium_image_uri,
+
+      :source_label,
+      :clean_address,
+      :description,
+      :half_baths,
+      :rooms_description,
+      :addr_street,
+      :addr_unit,
+      :normalized_addr_unit,
+      :addr_city,
+      :addr_lat,
+      :addr_lon,
+      :size_sqft_num,
+      :lot_size,
+      :size_description,
+      :ppsf,
+      :ppsf_num,
+      :ppsf_description,
+      :created_at,
+      :unit_type,
+      :unit_type_label,
+      :status,
+      :price_cur,
+      :floorplan,
+      :open_house_start,
+      :open_house_end,
+      :sourceid
+    ]
+    
+    class << self
+      def neighborhoods(*neighborhood)
+        @neighborhoods = neighborhood.join(',') if neighborhood.kind_of?(Array)
+        @neighborhoods = neighborhood           if neighborhood.kind_of?(String)
+        self
+      end
+
+      def rentals
+        @property_type = 'rentals'
+        self
+      end
+
+      def sales
+        @property_type = 'sales'
+        self
+      end
+
+      def options(*options)
+        @options = options.kind_of?(Array) ? options.flatten : options
+        self
+      end
+
+      def order(sort_type)
+        case sort_type
+          when :most_expensive  then @sort_type = "price_desc"
+          when :least_expensive then @sort_type = "price_asc"
+          when :newest          then @sort_type = "listed_desc"
+        end
+        self
+      end
+
+      def limit(limit)
+        @limit = limit
+        generate_properties
+      end
+
+      def all
+        @limit = 200 # the api limit
+        generate_properties
+      end
+
+      private
+      def generate_properties
+        parsed_reply = get_parsed_reply
+        properties = []
+
+        (0..@limit - 1).each do |i|
+          break if parsed_reply['listings'][i] == nil
+          rental = {}
+          OPTIONS.each do |option|
+            rental[option] = parsed_reply['listings'][i][option.to_s] if @options.include?(option)
+          end
+
+          properties << rental
+        end
+
+        properties
+      end
+
+
+      def get_parsed_reply
+        uri = StreetEasy::Client.construct_url({
+          property_type: @property_type,
+          neighborhoods: @neighborhoods,
+          limit: @limit,
+          order: @sort_type
+        })
+
+        reply = uri.read
+        parsed_reply = JSON.parse(reply)
+      end
+    end
+  end
+end

data/lib/street_easy/version.rb

@@ -1,3 +1,3 @@
 module StreetEasy
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/street_easy.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Chase Blokker"]
   spec.email         = ["chaseblokker@yahoo.com"]
   spec.summary       = %q{A ruby wrapper for the street easy API}
-  spec.homepage      = "http://rubygems.org/gems/street_easy"
+  spec.description   = %q{A ruby wrapper for the street easy API}
+  spec.homepage      = "https://rubygems.org/gems/street_easy"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: street_easy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Chase Blokker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-25 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,22 +52,25 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: A ruby wrapper for the street easy API
 email:
 - chaseblokker@yahoo.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/street_easy.rb
+- lib/street_easy/client.rb
+- lib/street_easy/property.rb
 - lib/street_easy/version.rb
+- spec/spec_helper.rb
+- spec/street_easy_helper.rb
+- street_easy-0.0.1.gem
 - street_easy.gemspec
-homepage: http://rubygems.org/gems/street_easy
+homepage: https://rubygems.org/gems/street_easy
 licenses:
 - MIT
 metadata: {}
@@ -91,4 +94,6 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A ruby wrapper for the street easy API
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/street_easy_helper.rb

data/.gitignore

@@ -1,22 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.bundle
-*.so
-*.o
-*.a
-mkmf.log

data/Rakefile

@@ -1,15 +0,0 @@
-require "bundler/gem_tasks"
-
-require 'rake/testtask'
-Rake::TestTask.new do |test|
-  test.libs << 'lib' << 'test'
-  test.ruby_opts << "-rubygems"
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
- 
-# test/helper.rb
-require 'street_easy'
-require 'minitest/spec'
-require 'minitest/autorun'
-