mccandlish 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTJhZjNhNmI0NWZlYzM0NDc4YzI2NWJkNjFkMmNkODExMzExYjBiMQ==
+  data.tar.gz: !binary |-
+    YWY4YzIwMjdmNDA5MzkzNmY1MjczNTAwY2UwN2Y2ZWY1YmIxMTgzZg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ODlmYzI4ZWVkZmNhYmIxOWQ5MTE3OWM2NWMxZTM0OTk5NzkxYzA4NmJkMTA4
+    YTMwZTVkNTY3MDAzMjNhYTU4YTA4NzkyZjE4ZjJkNmY4MTVlMDQwY2M0YmVi
+    NTcxZTdlY2RkOTk0N2Y2NGI2NjM4YTI5ZmZlZjliMDUzNjNjOWU=
+  data.tar.gz: !binary |-
+    MmNiMWE2MWRkZWM0MWI0YjY1YTQ2MjlmMTJkMGY3MzljOGY1NjlhMWM5OGU2
+    OTdlY2E4MDY3MGNlNTIyNmJiNWQxNTFiMWI5MmI1NDk4ZGIwZDk5Zjg4MjE3
+    OWJhZWM4OWMyY2ZhNGRmZmFjYTM3M2I5MjQ2YWMzYjE2YzkxM2I=

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+pkg
+spec/reports

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Derek Willis
+
+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,45 @@
+# McCandlish
+
+A thin Ruby wrapper for NYT Article Search API Version 2. The name comes from McCandlish Phillips, ["a tenacious reporter and a lyrical stylist"](http://www.nytimes.com/2013/04/10/business/media/mccandlish-phillips-times-reporter-dies-at-85.html?pagewanted=all) for The New York Times from 1952 to 1973.
+
+## THIS LIBRARY IS IN ALPHA STATE AND WILL CHANGE FREQUENTLY. DO NOT USE IT FOR ANYTHING, REALLY ##
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mccandlish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mccandlish
+
+## Usage
+
+You'll need an API key from [The New York Times](http://developer.nytimes.com/). Reading the [Article Search V2 API docs](http://developer.nytimes.com/docs/read/article_search_api_v2) wouldn't hurt, either. But once you have a key, you can get started like so:
+
+```
+require 'mccandlish'
+# create a client
+c = Mccandlish::Client.new('YOUR-API-KEY')
+# retrieve API results for articles and blog posts mentioning Afghanistan from the Foreign Desk on May 26, 2013:
+results = c.desk("Foreign").date("2013-05-26").query("Afghanistan").result
+results.hits
+ => 4
+article = results.articles.first
+=> #<Mccandlish::Article:0x007fca04897b20 @id="51a176ad46fdbf6c1db79139", @web_url="http://www.nytimes.com/2013/05/26/world/asia/in-afghan-transition-us-forces-take-a-step-back.html", @snippet="As the United States military moves into a support role in Afghanistan, a week spent with a brigade accompanying Afghan forces offered a direct look at the evolving training mission, for better or for worse.", ... @type_of_material="News", @word_count=1243>
+article.headline
+=> "In Afghan Transition, U.S. Forces Take a Step Back"
+```
+
+## 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,13 @@
+#!/usr/bin/env rake
+require 'bundler'
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'spec'
+  test.pattern = 'spec/*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/mccandlish.rb

@@ -0,0 +1,7 @@
+%w(article.rb client.rb result.rb version.rb).each do |f|
+  require File.join(File.dirname(__FILE__), 'mccandlish/', f)
+end
+
+module Mccandlish
+  # Your code goes here...
+end

data/lib/mccandlish/article.rb

@@ -0,0 +1,49 @@
+module Mccandlish
+
+  class Article
+    
+    attr_reader :id, :web_url, :snippet, :lead_paragraph, :abstract, :print_page, :blog, :source, :headline_seo, :headline,
+    :headline_print, :keywords, :date, :document_type, :news_desk, :byline, :type_of_material, :id, :word_count, :results, 
+    :byline, :section_name, :subsection_name, :kicker
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+       instance_variable_set("@#{k}", v)
+      end
+    end
+    
+    def self.create_from_results(results)
+      results.map{|result| Article.create(result)}
+    end
+    
+    def self.create(result)
+      self.new(:id => result['_id'],
+      :web_url => result['web_url'],
+      :snippet => result['snippet'],
+      :lead_paragraph => result['lead_paragraph'],
+      :abstract => result['abstract'],
+      :print_page => result['print_page'].to_i,
+      :blog => result['blog'],
+      :source => result['source'],
+      :headline_seo => result['headline']['seo'],
+      :headline => result['headline']['main'],
+      :kicker => result['headline']['kicker'],
+      :headline_print => result['headline']['print'],
+      :keywords => result['keywords'].sort_by{|k| k['rank'].to_i},
+      :date => Date.parse(result['pub_date']),
+      :document_type => result['document_type'],
+      :news_desk => result['news_desk'],
+      :section_name => result['section_name'],
+      :subsection_name => result['subsection_name'],
+      :byline => result['byline'],
+      :type_of_material => result['type_of_material'],
+      :word_count => result['word_count'].to_i
+      )
+    end
+    
+    
+    
+    
+    
+  end
+end

data/lib/mccandlish/client.rb

@@ -0,0 +1,122 @@
+require 'httparty'
+require 'oj'
+require 'cgi'
+
+module Mccandlish
+
+  class Client
+    
+    include HTTParty
+    
+    attr_reader :sort, :page, :query_filters, :result, :uri, :query, :api_key, :params
+    
+    def initialize(api_key=nil)
+      @api_key = api_key
+      @params = {}
+      @query_filters = []
+      @uri
+    end
+    
+    # clears out params, query_filters 
+    def reset
+      @params = {}
+      @query_filters = []
+      self
+    end
+
+    # Builds a request URI to call the API server
+    def build_request_url(params)
+      "http://api.nytimes.com/svc/search/v2/articlesearch.json?"+params
+    end
+
+    def prepare_params(params, api_key)
+      params.map {|k,v| k+'='+v.to_s}.join('&')+"&api-key=#{api_key}"
+    end
+
+    def invoke(params={})
+      raise "You must initialize the API key before you run any API queries" if self.api_key.nil?
+      full_params = prepare_params(params, api_key=self.api_key)
+      @uri = build_request_url(full_params)
+      response = HTTParty.get(@uri)
+      parsed_response = check_response(response)
+      Result.create_from_parsed_response(parsed_response)
+    end
+
+    def check_response(response)
+      # replace with actual error handling
+      raise "Authentication Error" if response.code == 403
+      raise "Bad Request" if response.code == 400
+      raise "Server Error" if response.code == 500
+      raise "Timeout" if response.code == 504
+      if response.code == 200
+        Oj.load(response.body)
+      else
+        return nil
+      end
+    end
+    
+    def result
+      invoke(params)
+    end
+    
+    def query(query)
+      params['q'] = CGI.escape(query)
+      params.merge!({'fq' => query_filters.uniq.join("+AND+")})
+      self
+    end
+    
+    # newest or oldest
+    def sort(sort)
+      params['sort'] = sort
+      self
+    end
+    
+    # response has maximum of 10 items, page is for pagination of results
+    def page(page)
+      params['page'] = page
+    end
+    
+    def dates(begin_date, end_date)
+      params['begin_date'] = begin_date if begin_date
+      params['end_date'] = end_date if end_date
+      self
+    end
+    
+    # Full day name: Monday, Tuesday, Wednesday, etc.
+    def day_of_week(day)
+      query_filters << "day_of_week:#{day}"
+      self
+    end
+    
+    # YYYY-MM-DD format
+    def date(date)
+      query_filters << "pub_date:#{date}"
+      self
+    end
+    
+    def year(year)
+      query_filters << "pub_year:#{year}"
+      self
+    end
+    
+    def location(location)
+      loc = CGI.escape(location)
+      query_filters << "glocations:#{loc}"
+      self
+    end
+    
+    # article, blogpost
+    def doc_type(doc_type)
+      query_filters << "document_type:#{doc_type}"
+      self
+    end
+    
+    # Foreign, Sports, Culture, etc.
+    def desk(desk)
+      # validate desk
+      query_filters << "news_desk:#{desk}"
+      self
+    end
+  end
+  
+end

data/lib/mccandlish/result.rb

@@ -0,0 +1,24 @@
+module Mccandlish
+
+  class Result
+    
+    attr_reader :hits, :offset, :copyright, :status, :articles
+    
+    def initialize(params={})
+      params.each_pair do |k,v|
+       instance_variable_set("@#{k}", v)
+      end
+    end
+    
+    def self.create_from_parsed_response(results)
+      self.new(:hits => results['response']['meta']['hits'],
+        :offset => results['response']['meta']['offset'],
+        :copyright => results['copyright'],
+        :status => results['status'],
+        :articles => Article.create_from_results(results['response']['docs'])
+      )
+    end
+    
+    
+  end
+end

data/lib/mccandlish/version.rb

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

data/mccandlish.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mccandlish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mccandlish"
+  spec.version       = Mccandlish::VERSION
+  spec.authors       = ["Derek Willis"]
+  spec.email         = ["dwillis@gmail.com"]
+  spec.description   = %q{A thin, hopefully elegant Ruby wrapper for Version 2 of the NYT Article Search API}
+  spec.summary       = %q{NYT Article Search API Ruby gem}
+  spec.homepage      = ""
+  spec.license       = "Apache"
+
+  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 "minitest"
+  spec.add_development_dependency "webmock"
+  spec.add_dependency "oj"
+  spec.add_dependency "httparty"
+  spec.add_dependency "american_date"
+end

data/spec/mccandlish/spec_client.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'mccandlish'
+
+describe Client do
+  it "should start with the website" do
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require "minitest/autorun"
+require_relative "../lib/mccandlish"
+require 'webmock/minitest'
+include Mccandlish
+

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: mccandlish
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Derek Willis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: american_date
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A thin, hopefully elegant Ruby wrapper for Version 2 of the NYT Article
+  Search API
+email:
+- dwillis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mccandlish.rb
+- lib/mccandlish/article.rb
+- lib/mccandlish/client.rb
+- lib/mccandlish/result.rb
+- lib/mccandlish/version.rb
+- mccandlish.gemspec
+- spec/mccandlish/spec_client.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Apache
+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.0.3
+signing_key: 
+specification_version: 4
+summary: NYT Article Search API Ruby gem
+test_files:
+- spec/mccandlish/spec_client.rb
+- spec/spec_helper.rb