NYTimesAPI 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 405f2fa0106b658c3eec12e0c443a403bb6ad4b7
+  data.tar.gz: 8fbd4a9935ce0f84c1b6efbad34e522c402eda37
+SHA512:
+  metadata.gz: 2667bd028d1fd86c9051f33971cdc43bed5d71c9828a1f572de38596175c797ab84e13e840a41895dfcd997383b80f2908dd0b79f42f5c697a7cb99f603b3b4c
+  data.tar.gz: 5458b8ad734977fdbec19512425e4c336e37f0b49ba6c792b7faff5430d8fb9163be17786a1ad726554bc375c43ecf3d4e98a55092c8dd755f4655a839e88694

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Rodrigo Alves
+
+MIT License
+
+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/NYTimesAPI.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'NYTimesAPI/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "NYTimesAPI"
+  spec.version       = NYTimesAPI::VERSION
+  spec.authors       = ["Rodrigo Alves"]
+  spec.email         = ["rodrigovieira1994@gmail.com"]
+  spec.summary       = %q{The New York Times API}
+  spec.description   = %q{The New York Times API wrapper}
+  spec.homepage      = "https://github.com/rodrigoalvesvieira/NYTimesAPI"
+  spec.license       = "MIT"
+
+  spec.files = Dir["{lib/**/*,spec/*}"] + Dir.entries(".").select { |f| File.file?(f) }.reverse[0..6] - ["NYTimesAPI-0.0.1.gem"]
+
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/README.md

@@ -0,0 +1,47 @@
+# NYTimesAPI
+
+Ruby wrapper for The New York Times API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'NYTimesAPI'
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install NYTimesAPI
+```
+
+## Usage
+
+### Real State API
+
+First initialize the object, using your api key:
+
+```ruby
+ny = NYTimesAPI::RealState.new "myawesomapikey"
+```
+
+###### Count
+
+```ruby
+result = ny.counts "Manhattan", {date: "2007-07", bedrooms: 2, type: 3}
+```
+
+###### Percentiles
+
+```ruby
+result = ny.percentiles "Manhattan", {date: "2007-07", bedrooms: 2, type: 3}
+```
+
+## Author
+
+* Rodrigo Alves <rodrigovieira1994@gmail.com>
+
+## Copyright
+
+© 2014 Rodrigo Alves

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc "Run tests"
+task default: :test

data/keys.txt

@@ -0,0 +1,17 @@
+keys
+
+Article Search API key: 03c313e0c9d4f06be219c2208077a316:10:69806191
+Real Estate API key: f17b219b0e058af6865859ca4d16c2a0:6:69806191
+Movie Reviews API key: 4a81cec4dbc2aa11cbb40cd1f2658b7a:11:69806191
+Most Popular API key: 3472b490fb7b58f6fd13bec0aa59f47e:9:69806191
+Geo API key: adc2e189e41ec0e77b1e88e0330864d0:17:69806191
+Event Listings API key: cab9ae8f0a7da535aa4eb87818a0a458:2:69806191
+Districts API key: 241055ba40d37493ca89e9c7d5921743:8:69806191
+Congress API key: c3f176bcf5d5c36095b4953c1aed75ec:19:69806191
+Community API key: 450c852f37e40f3136ecb111fe12af82:18:69806191
+Campaign Finance API key: 46bb03b7f99f49f4a74a871eaf25b123:13:69806191
+Best Sellers API key: c3f93ac81cb1100af5af1c37aeafc817:17:69806191
+Article Search API key: 03c313e0c9d4f06be219c2208077a316:10:69806191
+Semantic API key: f4fc80edc884b5bb3a1a46e09623bea0:13:69806191
+Times Newswire API key: ccc07679e9f238354059b44e2a682ed1:3:69806191
+TimesTags API key: 73b55c2fac1c383dd2a2365e5b3c5350:11:69806191

data/lib/NYTimesAPI.rb

@@ -0,0 +1,24 @@
+require "uri"
+require "net/http"
+require "json"
+
+require "NYTimesAPI/version"
+
+module NYTimesAPI
+  autoload :Util,             "NYTimesAPI/util"
+
+  autoload :ArticleSearch,    "NYTimesAPI/article_search"
+  autoload :BestSellers,      "NYTimesAPI/best_sellers"
+  autoload :CampaignFinance,  "NYTimesAPI/campaign_finance"
+  autoload :Community,        "NYTimesAPI/community"
+  autoload :Congress,         "NYTimesAPI/congress"
+  autoload :Districts,        "NYTimesAPI/districts"
+  autoload :EventListings,    "NYTimesAPI/event_listings"
+  autoload :Geographic,       "NYTimesAPI/geographic"
+  autoload :MostPopular,      "NYTimesAPI/most_popular"
+  autoload :MovieReviews,     "NYTimesAPI/movie_reviews"
+  autoload :RealState,        "NYTimesAPI/real_state"
+  autoload :Semantic,         "NYTimesAPI/semantic"
+  autoload :TimesNewswire,    "NYTimesAPI/times_newswire"
+  autoload :Timestags, "      NYTimesAPI/timestags"
+end

data/lib/NYTimesAPI/article_search.rb

@@ -0,0 +1,8 @@
+module NYTimesAPI
+  class ArticleSearch
+    VERSION =  "v2"
+    BASE_URL = "http://api.nytimes.com/svc/search/v2/articlesearch.response-format?[q=search term&fq=filter-field:(filter-term)&additional-params=values]&api-key=####
+"
+
+  end
+end

data/lib/NYTimesAPI/best_sellers.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class BestSellers
+  end
+end

data/lib/NYTimesAPI/campaign_finance.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class CampaignFinance
+  end
+end

data/lib/NYTimesAPI/community.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class Community
+  end
+end

data/lib/NYTimesAPI/congress.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class Congress
+  end
+end

data/lib/NYTimesAPI/districts.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class Districts
+  end
+end

data/lib/NYTimesAPI/event_listings.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class EventListings
+  end
+end

data/lib/NYTimesAPI/geographic.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class Geographic
+  end
+end

data/lib/NYTimesAPI/most_popular.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class MostPopular
+  end
+end

data/lib/NYTimesAPI/movie_reviews.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class MovieReviews
+  end
+end

data/lib/NYTimesAPI/real_state.rb

@@ -0,0 +1,139 @@
+module NYTimesAPI
+  class RealState
+    API_VERSION = "v2"
+    BASE_URL = "http://api.nytimes.com/svc/real-estate/#{API_VERSION}/listings/percentile/50.json?geo-extent-level=borough&"
+
+    SUCCESS = "OK"
+
+    GEO_SUMMARY_LEVELS = %w(borough neighborhood zip)
+
+    BUILDING_TYPES = {
+      "Apartments" => 2
+    }
+
+    class << self
+      def enable_url_for(resource_type, query_type)
+        return "http://api.nytimes.com/svc/real-estate/#{API_VERSION}/#{resource_type}/#{query_type}/50.json?geo-extent-level=borough&"
+      end
+    end
+
+    attr_accessor :api_key, :requests_count
+
+    def initialize(api_key)
+      @api_key = api_key
+      @requests_count = 0
+    end
+
+    def counts(location, options)
+      base_url = RealState.enable_url_for("listings", "count")
+
+      geo_summary_level = options[:geo_summary_level] || GEO_SUMMARY_LEVELS.first
+      url = "#{base_url}geo-extent-value=#{location}&geo-summary-level=#{geo_summary_level}&date-range=#{options[:date]}&bedrooms=#{options[:bedrooms]}&building-type-id=#{options[:type]}&api-key=#{self.api_key}"
+
+      json = NYTimesAPI::Util.get_json(url)
+      self.requests_count += 1
+
+      results = []
+
+      if json["status"] == SUCCESS
+        json["results"].each do |res|
+
+          result_item = {
+            borough: res["borough"],
+            date_format: res["date_format"],
+            date: res["date"],
+            count: res["count"]
+          }
+
+          results.push result_item
+        end
+      end
+
+      return results
+    end
+
+    def percentiles(location, options={})
+      base_url = RealState.enable_url_for("listings", "percentile")
+
+      url = "#{base_url}geo-extent-value=#{location}&date-range=#{options[:date]}&bedrooms=#{options[:bedrooms]}&building-type-id=#{options[:type]}&api-key=#{self.api_key}"
+      json = NYTimesAPI::Util.get_json(url)
+      self.requests_count += 1
+
+      results = []
+
+      if json["status"] == SUCCESS
+        json["results"].each do |res|
+
+          result_item = {
+            borough: res["borough"],
+            date_format: res["date_format"],
+            date: res["date"],
+            percentile: res["percentile"],
+            listing_price: res["listing_price"]
+          }
+
+          results.push result_item
+        end
+      end
+
+      return results
+    end
+
+    def sales_percentiles(location, options={})
+      base_url = RealState.enable_url_for("sales", "percentile")
+
+      geo_summary_level = options[:geo_summary_level] || GEO_SUMMARY_LEVELS.first
+      url = "#{base_url}geo-extent-value=#{location}&geo-summary-level=#{geo_summary_level}&date-range=#{options[:date]}&bedrooms=#{options[:bedrooms]}&building-type-id=#{options[:type]}&api-key=#{self.api_key}"
+
+      json = NYTimesAPI::Util.get_json(url)
+      self.requests_count += 1
+
+      results = []
+
+      if json["status"] == SUCCESS
+        json["results"].each do |res|
+
+          result_item = {
+            zip: res["zip"],
+            date_format: res["date_format"],
+            date: res["date"],
+            percentile: res["percentile"],
+            sale_price: res["sale_price"]
+          }
+
+          results.push result_item
+        end
+      end
+
+      return results
+    end
+
+    def sales_counts(location, options={})
+      base_url = RealState.enable_url_for("sales", "count")
+
+      geo_summary_level = options[:geo_summary_level] || GEO_SUMMARY_LEVELS.first
+      url = "#{base_url}geo-extent-value=#{location}&geo-summary-level=#{geo_summary_level}&date-range=#{options[:date]}&bedrooms=#{options[:bedrooms]}&building-type-id=#{options[:type]}&api-key=#{self.api_key}"
+
+      json = NYTimesAPI::Util.get_json(url)
+      self.requests_count += 1
+
+      results = []
+
+      if json["status"] == SUCCESS
+        json["results"].each do |res|
+
+          result_item = {
+            neighborhood: res["neighborhood"],
+            date_format: res["date_format"],
+            date: res["date"],
+            count: res["count"]
+          }
+
+          results.push result_item
+        end
+      end
+
+      return results
+    end
+  end
+end

data/lib/NYTimesAPI/semantic.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class Semantic
+  end
+end

data/lib/NYTimesAPI/times_newswire.rb

@@ -0,0 +1,4 @@
+module NYTimesAPI
+  class TimesNewswire
+  end
+end

data/lib/NYTimesAPI/timestags.rb

@@ -0,0 +1,5 @@
+module NYTimesAPI
+  class Timestags
+
+  end
+end

data/lib/NYTimesAPI/util.rb

@@ -0,0 +1,13 @@
+module NYTimesAPI
+  class Util
+    class << self
+
+      def get_json(url)
+        url = URI.encode(url)
+        uri = URI.parse(url)
+
+        json = JSON.parse(Net::HTTP.get_response(uri).body)
+      end
+    end
+  end
+end

data/lib/NYTimesAPI/version.rb

@@ -0,0 +1,3 @@
+module NYTimesAPI
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: NYTimesAPI
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rodrigo Alves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: The New York Times API wrapper
+email:
+- rodrigovieira1994@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- NYTimesAPI.gemspec
+- README.md
+- Rakefile
+- keys.txt
+- lib/NYTimesAPI.rb
+- lib/NYTimesAPI/article_search.rb
+- lib/NYTimesAPI/best_sellers.rb
+- lib/NYTimesAPI/campaign_finance.rb
+- lib/NYTimesAPI/community.rb
+- lib/NYTimesAPI/congress.rb
+- lib/NYTimesAPI/districts.rb
+- lib/NYTimesAPI/event_listings.rb
+- lib/NYTimesAPI/geographic.rb
+- lib/NYTimesAPI/most_popular.rb
+- lib/NYTimesAPI/movie_reviews.rb
+- lib/NYTimesAPI/real_state.rb
+- lib/NYTimesAPI/semantic.rb
+- lib/NYTimesAPI/times_newswire.rb
+- lib/NYTimesAPI/timestags.rb
+- lib/NYTimesAPI/util.rb
+- lib/NYTimesAPI/version.rb
+homepage: https://github.com/rodrigoalvesvieira/NYTimesAPI
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: The New York Times API
+test_files: []