grifter 0.0.4

data/Gemfile

@@ -0,0 +1,12 @@
+source :rubygems
+
+#gemspec
+
+gem 'json'
+
+group :development do
+  gem 'rspec'
+  gem 'pry'
+  gem 'awesome_print'
+  gem 'jeweler'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Robert Schultheis
+
+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/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "grifter"
+  gem.homepage = "http://github.com/knewton/grifter"
+  gem.license = "MIT"
+  gem.summary = %Q{Make calls to HTTP JSON APIs with ease and confidence}
+  gem.description = %Q{convention based approach to interfacing with an HTTP JSON API.}
+  gem.email = "rob@knewton.com"
+  gem.authors = ["Robert Schultheis"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "grifter #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/Readme.md

@@ -0,0 +1,119 @@
+Grifter
+=======
+Grifter makes it smooth to work with JSON HTTP APIs with confidence
+
+Features
+--------
+- Work with multiple APIs
+- Work with multiple deployment environments (Staging, Production, etc.)
+- Script calls to API(s)
+- Command line calls to API(s)
+- Craft clean API tests using the included RSPec helper
+- Unified approach to handling request errors
+- Convention over configuration approach to defining the API interface
+
+Getting Started
+---------------
+Lets demo how this works using a simple example of an API that requires no
+authentication.
+
+The OpenWeatherMap is a good candidate for a simple API
+which is accessible without needing any authentication key:
+[http://api.openweathermap.org/]
+
+
+### make a project directory
+
+    mkdir weather
+    cd weather
+
+### setup grifter.yml
+
+     services:
+       owm:
+         hostname: api.openweathermap.org
+
+### make the grifts directory, and a grift file
+
+    mkdir owm_grifts
+    touch owm_grifts/weather_grifts.rb
+
+### add method for checking weather to owm/weather.rb
+    def weather_for city
+      owm.get "/data/2.5/weather?q=#{URI.encode(city)}"
+    end
+
+### Call it from the cmd line:
+    $ grift weather_for 'Pleasantville, NY'
+
+And that returns something like this:
+    {"coord"=>{"lon"=>-73.79169, "lat"=>41.13436}, "sys"=>{"country"=>"United States of America", "sunrise"=>1366883974, "sunset"=>1366933583}, "weather"=>[{"id"=>501, "main"=>"Rain", "description"=>"moderate rain", "icon"=>"10d"}], "base"=>"global stations", "main"=>{"temp"=>290.46, "humidity"=>26, "pressure"=>1020, "temp_min"=>289.15, "temp_max"=>292.59}, "wind"=>{"speed"=>2.06, "gust"=>4.11, "deg"=>265}, "rain"=>{"1h"=>2.32}, "clouds"=>{"all"=>0}, "dt"=>1366926419, "id"=>5131757, "name"=>"Pleasantville", "cod"=>200}
+
+Use the -v command line option and see the full request/response logged to StdOut
+
+### Script it
+Make a file called temperatures.rb with this in it:
+
+    [
+      'New York, NY',
+      'Toronto, Canada',
+      'Paris, France',
+      'Tokyo, Japan',
+      'Sydney, Australia',
+    ].each do |city|
+      weather = weather_for city
+      kelvin = weather['main']['temp']
+      celcius = (kelvin - 273.15).round
+      puts "#{city}: #{celcius} celcius"
+    end
+
+And then run the grift script like so:
+
+    grift -f temperatures.rb
+
+And get this nice output:
+
+    I: [04/25/13 17:59:22][grifter] - Running data script 'temperatures.rb'
+    New York, NY: 18 celcius
+    Toronto, Canada: 7 celcius
+    Paris, France: 18 celcius
+    Tokyo, Japan: 16 celcius
+    Sydney, Australia: 14 celcius
+
+### Test it
+Using the included helper module, testing an api becomes easy.  Lets setup a simple RSpec example.  Step one is create the spec folder:
+
+    mkdir spec
+
+Setup spec/spec_helper.rb with contents like:
+
+    require 'grifter/helpers'
+
+    RSpec.configure do |config|
+      config.include Grifter::Helpers
+    end
+
+Setup spec/weather_spec.rb with contents like:
+
+    require 'spec_helper'
+    describe "getting weather reports" do
+      it "should know the weather for New York City" do
+        response = weather_for 'New York, NY'
+        response['main'].keys.should =~ ['temp', 'temp_min', 'temp_max', 'humidity', 'pressure']
+      end
+    end
+
+Run it:
+
+    gem install rspec
+    rspec
+
+And get back:
+
+    1 example, 0 failures
+
+
+Copyright
+---------
+Copyright (c) 2013 Knewton. See LICENSE.txt for
+further details.

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/bin/grift

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+require_relative '../lib/grifter'
+
+Log = Grifter::Log
+
+Log.level = Logger::INFO
+
+#Deal with the cmd line
+def parse_cmd_line
+  options = {
+      files: [],
+      config_file: 'grifter.yml',
+      authenticate: true,
+      environment: nil,
+  }
+
+  optparse = OptionParser.new do |opts|
+    opts.banner = %Q|
+      Grifter HTTP JSON APIs Client
+      example, run a data script: bin/grifter -f script.rb
+      example, call a method:     bin/grifter <grift method name>
+
+    |
+
+    opts.on("-f", "--script=FILENAME",
+      "specify a script file to run") { |file| options[:files] << file }
+
+    opts.on("-v", "--verbose",
+      "enable debug logging") { Log.level = Logger::DEBUG }
+
+    opts.on("-c", "--config=FILENAME",
+      "config filename") { |fn| options[:config_file] = fn }
+
+    opts.on('-e', '--environment=ENVIRONMENT',
+           "environment name") { |e| options[:environment] = e.to_sym }
+
+    opts.on("-d", "--no_authenticate",
+           "Do not authenticate") { options[:authenticate] = false }
+
+  end
+  optparse.parse!
+  options
+end
+options = parse_cmd_line
+
+grifter = Grifter.new options
+
+if not(ARGV.empty?)
+  method = ARGV.shift
+  response = grifter.send(method.to_sym, *ARGV)
+  puts response.inspect
+
+elsif not(options[:files].empty?)
+  options[:files].each do |script_file|
+    grifter.run_script_file(script_file)
+  end
+
+else
+  Kernel.abort "Nothing to do?  use -f or give a method name on the cmd line"
+end

data/example/grifter.yml

@@ -0,0 +1,7 @@
+#base configuration of services goes here
+services:
+  owm:
+    hostname: 'api.openweathermap.org'
+
+grift_globs:
+  - 'example/**/*_grifts.rb'

data/example/owm_grifts/weather_grifts.rb

@@ -0,0 +1,3 @@
+def weather_for city
+  owm.get "/data/2.5/weather?q=#{URI.encode(city)}"
+end

data/example/temperatures.rb

@@ -0,0 +1,12 @@
+[
+  'New York, NY',
+  'Toronto, Canada',
+  'Paris, France',
+  'Tokyo, Japan',
+  'Sydney, Australia',
+].each do |city|
+  weather = weather_for city
+  kelvin = weather['main']['temp']
+  celcius = (kelvin - 273.15).round
+  puts "#{city}: #{celcius} celcius"
+end

data/grifter.gemspec

@@ -0,0 +1,80 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "grifter"
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Robert Schultheis"]
+  s.date = "2013-05-09"
+  s.description = "convention based approach to interfacing with an HTTP JSON API."
+  s.email = "rob@knewton.com"
+  s.executables = ["grift"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "Rakefile",
+    "Readme.md",
+    "VERSION",
+    "bin/grift",
+    "example/grifter.yml",
+    "example/owm_grifts/weather_grifts.rb",
+    "example/temperatures.rb",
+    "grifter.gemspec",
+    "lib/grifter.rb",
+    "lib/grifter/blankslate.rb",
+    "lib/grifter/configuration.rb",
+    "lib/grifter/helpers.rb",
+    "lib/grifter/http_service.rb",
+    "lib/grifter/json_helpers.rb",
+    "lib/grifter/log.rb",
+    "spec/configuration_spec.rb",
+    "spec/grifter_spec.rb",
+    "spec/http_service_spec.rb",
+    "spec/json_helpers_spec.rb",
+    "spec/resources/example_config.yml",
+    "spec/resources/grifter.yml",
+    "spec/resources/syntax_error_grifts/eval_error_grifts.rb",
+    "spec/resources/twitter_grifts/oauth_grifts.rb",
+    "spec/resources/twitter_grifts/timeline_grifts.rb",
+    "spec/rspec_helper_spec.rb",
+    "spec/support/require_all_lib_files.rb",
+    "spec/support/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/knewton/grifter"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Make calls to HTTP JSON APIs with ease and confidence"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+      s.add_development_dependency(%q<awesome_print>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+      s.add_dependency(%q<awesome_print>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+    s.add_dependency(%q<awesome_print>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/lib/grifter.rb

@@ -0,0 +1,77 @@
+require_relative 'grifter/http_service'
+require_relative 'grifter/configuration'
+require_relative 'grifter/log'
+require_relative 'grifter/blankslate'
+
+class Grifter
+  include Grifter::Configuration
+
+  DefaultConfigOptions = {
+    #TODO: service_config: nil,
+    grift_globs: ['*_grifts/**/*_grifts.rb'],
+    authenticate: false,
+    load_from_config_file: true,
+    services: {},
+  }
+  def initialize options={}
+    options = DefaultConfigOptions.merge(options)
+    @config = if options[:load_from_config_file]
+                options.merge load_config_file(options)
+              else
+                options
+              end
+
+    #setup the services
+    @services = []
+    @config[:services].each_pair do |service_name, service_config|
+      service = HTTPService.new(service_config)
+      define_singleton_method service_name.intern do
+        service
+      end
+      @services << service
+    end
+
+    #setup the grifter methods if any
+    if @config[:grift_globs]
+      @config[:grift_globs].each do |glob|
+        Dir[glob].each do |grifter_file|
+          load_grifter_file grifter_file
+        end
+      end
+    end
+
+    if @config[:authenticate]
+      self.grifter_authenticate_do
+    end
+  end
+
+  attr_reader :services
+
+  def load_grifter_file filename
+    Log.debug "Loading extension file '#{filename}'"
+    anon_mod = Module.new
+    #by evaling in a anonymous module, we protect this class's namespace
+    load_dir = File.dirname(filename)
+    $: << load_dir
+    anon_mod.class_eval(IO.read(filename), filename, 1)
+    $:.pop
+    self.extend anon_mod
+  end
+
+  def run_script_file filename
+    Log.info "Running data script '#{filename}'"
+    raise "No such file '#{filename}'" unless File.exist? filename
+    #by running in a anonymous class, we protect this class's namespace
+    anon_class = BlankSlate.new(self)
+    anon_class.instance_eval(IO.read(filename), filename, 1)
+  end
+
+  #calls all methods that end with grifter_authenticate
+  def grifter_authenticate_do
+    auth_methods = self.singleton_methods.select { |m| m =~ /grifter_authenticate$/ }
+    auth_methods.each do |m|
+      Log.debug "Executing a grifter_authentication on method: #{m}"
+      self.send(m)
+    end
+  end
+end