nytimes-article-search 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kazuhiro Yamada
+
+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/README.md

@@ -0,0 +1,29 @@
+# NytimesArticle
+
+A thin Ruby client for The New York Times Article Search API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nytimes-article-search'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nytimes-article-search
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/bin/nytimes-article-search

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'nytimes/article/search'

data/lib/nytimes-article/version.rb

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

data/lib/nytimes-article.rb

@@ -0,0 +1,68 @@
+require 'rubygems'
+require 'open-uri'
+require 'json'
+require 'date'
+require "nytimes-article/version"
+
+module NytimesArticle
+  class << self
+    API_SERVER  = 'api.nytimes.com'
+    API_VERSION = 'v1'
+    API_NAME    = 'search'
+    API_BASE    = "/svc/#{API_NAME}/#{API_VERSION}/article"
+
+    @@api_key          = nil
+    @@debug            = false
+    @@copyright        = nil
+    @@semantic_api_key = nil
+
+    ##
+    # Set the API key used for operations. This needs to be called before any requests against the API. To obtain an API key, go to http://developer.nytimes.com/
+    def api_key=(key)
+      @@api_key = key
+    end
+
+    def api_key
+      @@api_key
+    end
+
+    def semantic_api_key=(key)
+      @@semantic_api_key = key
+    end
+
+    def api_key
+      @@semantic_api_key
+    end
+
+    def datetime_parser(datetime)
+      datetime ? DateTime.parse(datetime) : nil
+    end
+
+    ##
+    # Builds a request URI to call the API server
+    def build_request_url(params)
+      URI::HTTP.build :host => API_SERVER, :path => API_BASE, :query => params.map {|k,v| "#{k}=#{v}"}.join('&')
+    end
+
+    def search(params={})
+      begin
+        if @@api_key.nil?
+          raise "You must initialize the API key before you run any API queries"
+        end
+        full_params  = params.merge 'api-key' => @@api_key, 'format' => 'json'
+        uri          = build_request_url(full_params)
+        reply        = uri.read
+        parsed_reply = JSON.parse reply
+        if parsed_reply.nil?
+          raise "Empty reply returned from API"
+        end
+        parsed_reply
+      rescue OpenURI::HTTPError => e
+        if e.message =~ /^404/
+          return nil
+        end
+        raise "Error connecting to URL #{uri} #{e}"
+      end
+    end
+  end
+end

data/nytimes-article-search.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nytimes-article/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nytimes-article-search"
+  spec.version       = NytimesArticle::VERSION
+  spec.authors       = ["Kazuhiro Yamada"]
+  spec.email         = ["yamadakazu45@gmail.com"]
+  spec.description   = %q{A thin Ruby client for The New York Times Article Search API}
+  spec.summary       = %q{A thin Ruby client for The New York Times Article Search API}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/nytimes_article_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'tempfile'
+require 'pp'
+
+describe NytimesArticle do
+
+  describe ".search" do
+    context "search by no query" do
+      before(:each) do
+        @articles = NytimesArticle.search
+      end
+
+      it "should return 0 articles" do
+        @articles["total"].should  == 0
+      end
+    end
+
+    context "search by query" do
+      before(:each) do
+        @articles = NytimesArticle.search(
+          :query      => 'obama',
+          :begin_date => '20130401',
+          :end_date   => '20130402'
+        )
+      end
+
+      it "should return articles" do
+        @articles["total"].should  == 26
+        article = @articles['results'][0]
+        article['date']  = '20130402'
+        article['title'] = "U.S. Sees North Korea Blustering, Not Acting"
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'nytimes-article' # and any other gems you need
+
+API_KEY                = ENV['NYTIMES_ARTICLE_SEARCH_API_KEY']
+NytimesArticle.api_key = API_KEY
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: nytimes-article-search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kazuhiro Yamada
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A thin Ruby client for The New York Times Article Search API
+email:
+- yamadakazu45@gmail.com
+executables:
+- nytimes-article-search
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/nytimes-article-search
+- lib/nytimes-article.rb
+- lib/nytimes-article/version.rb
+- nytimes-article-search.gemspec
+- spec/nytimes_article_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A thin Ruby client for The New York Times Article Search API
+test_files:
+- spec/nytimes_article_spec.rb
+- spec/spec_helper.rb