grifter 0.0.5 → 0.0.6

data/Gemfile.lock

@@ -0,0 +1,40 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    awesome_print (1.1.0)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    method_source (0.8.1)
+    pry (0.9.12.1)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    slop (3.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  jeweler
+  json
+  pry
+  rspec

data/bin/grift

@@ -27,8 +27,14 @@ def parse_cmd_line
     opts.on("-f", "--script=FILENAME",
       "specify a script file to run") { |file| options[:files] << file }
 
+    opts.on("-d", "--script-dir=dir",
+      "specify a directory of grift scripts, run all of them") { |dir| options[:files] += Dir["#{dir}/**/*.rb"] }
+
     opts.on("-v", "--verbose",
-      "enable debug logging") { Log.level = Logger::DEBUG }
+      "debug logging, see every request and response in detail") { Log.level = Logger::DEBUG }
+
+    opts.on("-q", "--verbose",
+      "quiet logging, warnings and errors only") { Log.level = Logger::WARN }
 
     opts.on("-c", "--config=FILENAME",
       "config filename") { |fn| options[:config_file] = fn }
@@ -36,7 +42,7 @@ def parse_cmd_line
     opts.on('-e', '--environment=ENVIRONMENT',
            "environment name") { |e| options[:environment] = e.to_sym }
 
-    opts.on("-d", "--no_authenticate",
+    opts.on("-n", "--no_authenticate",
            "Do not authenticate") { options[:authenticate] = false }
 
   end
@@ -47,12 +53,15 @@ options = parse_cmd_line
 
 grifter = Grifter.new options
 
+
 if not(ARGV.empty?)
+  #a grift method has been specified on the command line
   method = ARGV.shift
   response = grifter.send(method.to_sym, *ARGV)
   puts response.inspect
 
 elsif not(options[:files].empty?)
+  #some grift files were specified on the command line?
   options[:files].each do |script_file|
     grifter.run_script_file(script_file)
   end

data/grifter.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "grifter"
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robert Schultheis"]
-  s.date = "2013-05-14"
+  s.date = "2013-05-15"
   s.description = "convention based approach to interfacing with an HTTP JSON API."
   s.email = "rob@knewton.com"
   s.executables = ["grift"]
@@ -18,14 +18,10 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     "Gemfile",
+    "Gemfile.lock",
     "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",
@@ -33,19 +29,7 @@ Gem::Specification.new do |s|
     "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"
+    "lib/grifter/log.rb"
   ]
   s.homepage = "http://github.com/knewton/grifter"
   s.licenses = ["MIT"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grifter
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -100,14 +100,10 @@ extra_rdoc_files:
 - LICENSE.txt
 files:
 - Gemfile
+- Gemfile.lock
 - 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
@@ -116,18 +112,6 @@ files:
 - 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
 homepage: http://github.com/knewton/grifter
 licenses:
 - MIT
@@ -143,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4169256621702839743
+      hash: 1598752812454653536
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/Rakefile

@@ -1,41 +0,0 @@
-# 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/VERSION

@@ -1 +0,0 @@
-0.0.5

data/example/grifter.yml

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

data/example/owm_grifts/weather_grifts.rb

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

data/example/temperatures.rb

@@ -1,12 +0,0 @@
-[
-  '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/spec/configuration_spec.rb

@@ -1,127 +0,0 @@
-require 'grifter/configuration'
-
-describe Grifter::Configuration do
-
-  let(:configuration) { Class.new.extend(Grifter::Configuration) }
-
-  let(:empty_config) { {} }
-
-  let (:no_service_config) { { services: {} } }
-
-  let (:single_basic_service_config) {
-    {
-      services: {
-                  twitter: { hostname: 'twitter.com' }
-                }
-    }
-  }
-
-  let (:all_service_values_defined) {
-    {
-      services: {
-        twitter: {
-          hostname: 'twitter.com',
-          port: 8888,
-          ssl: true,
-          ignore_ssl_cert: true,
-          base_uri: '/api/v2',
-        }
-      }
-    }
-  }
-
-  describe "Service configuration normalization" do
-    it "should require a services block" do
-      expect { configuration.normalize_config empty_config }.to raise_error GrifterConfigurationError
-    end
-
-    it "should require at least one service in service block" do
-      expect { configuration.normalize_config no_service_config }.to raise_error GrifterConfigurationError
-    end
-
-    it "should default ssl, ssl_certificate_ignore, and port" do
-      config = configuration.normalize_config single_basic_service_config
-      config[:services].should eql({
-        twitter: {
-          hostname: 'twitter.com',
-          port: 80,
-          ssl: false,
-          ignore_ssl_cert: false,
-          base_uri: '',
-          name: 'twitter',
-        }}
-      )
-    end
-
-    it "should allow overrides for all values" do
-      config = configuration.normalize_config all_service_values_defined
-      config.should eql(all_service_values_defined)
-    end
-  end
-
-  describe "loading config from a file" do
-    it "should allow specifying a filename" do
-      config = configuration.load_config_file config_file: 'spec/resources/example_config.yml'
-      config[:services].should eql({
-        myapi: {
-          hostname: 'myapi.com',
-          name: 'myapi',
-          port: 80,
-          ssl: false,
-          ignore_ssl_cert: false,
-          base_uri: '',
-        },
-        myotherapi: {
-          hostname: 'myotherapi.com',
-          name: 'myotherapi',
-          port: 80,
-          ssl: false,
-          ignore_ssl_cert: false,
-          base_uri: '',
-        },
-      })
-    end
-
-    it "should take the filename from an environment variable if specified" do
-      ENV['GRIFTER_CONFIG_FILE'] = 'spec/resources/example_config.yml'
-      config = configuration.load_config_file
-      config[:services].keys.should =~ [:myapi, :myotherapi]
-      ENV['GRIFTER_CONFIG_FILE'] = nil
-    end
-  end
-
-  describe "environment based overriding" do
-    it "should allow overriding configuration based on an environment name" do
-      config = configuration.load_config_file config_file: 'spec/resources/example_config.yml',
-                                              environment: :dev
-      config[:services].should eql({
-        myapi: {
-          hostname: 'dev.myapi.com',
-          name: 'myapi',
-          port: 123,
-          ssl: false,
-          ignore_ssl_cert: false,
-          base_uri: '',
-        },
-        myotherapi: {
-          hostname: 'myotherapi.com',
-          name: 'myotherapi',
-          port: 80,
-          ssl: false,
-          ignore_ssl_cert: false,
-          base_uri: '',
-        },
-      })
-
-    end
-
-    it "should allow setting environment via an environment variable" do
-      ENV['GRIFTER_ENVIRONMENT'] = 'dev'
-      config = configuration.load_config_file config_file: 'spec/resources/example_config.yml'
-
-      config[:services][:myapi][:hostname].should eql 'dev.myapi.com'
-      ENV['GRIFTER_ENVIRONMENT'] = nil
-
-    end
-  end
-end

data/spec/grifter_spec.rb

@@ -1,52 +0,0 @@
-require 'grifter'
-
-describe Grifter do
-  describe "Configuration" do
-    it "should allow for initializing from a config file" do
-      grifter = Grifter.new :config_file => 'spec/resources/example_config.yml'
-      grifter.should respond_to(:myapi)
-      grifter.myapi.name.should eql('myapi')
-      grifter.services.any?{|s| s.name == 'myapi' }.should be_true
-
-      grifter.should respond_to(:myotherapi)
-      grifter.myotherapi.name.should eql('myotherapi')
-      grifter.services.any?{|s| s.name == 'myotherapi' }.should be_true
-    end
-  end
-
-  describe "Grifter files" do
-    it "should allow loading grifter files which define methods for interacting with apis" do
-      grifter = Grifter.new :config_file => 'spec/resources/grifter.yml'
-      grifter.should respond_to :timeline_for
-    end
-
-    describe "syntax errors" do
-      it "should produce a nice stack trace if a grifter file has a syntax error" do
-        expect do
-          grifter = Grifter.new load_from_config_file: false,
-            grift_globs: ['spec/resources/syntax_error_grifts/eval_error_grifts.rb']
-        end.to raise_error NoMethodError
-      end
-    end
-  end
-
-  describe "Authentication" do
-    it "when authenticate is invoked, it should call any method ending in grifter_authenticate" do
-      grifter = Grifter.new :config_file => 'spec/resources/example_config.yml'
-      grifter.define_singleton_method :test_svc_grifter_authenticate do
-        true
-      end
-      grifter.define_singleton_method :test_svc_grifter_authenticate_substring_only do
-        true
-      end
-
-      grifter.should_receive :test_svc_grifter_authenticate
-      grifter.should_not_receive :test_svc_grifter_authenticate_substring_only
-
-      grifter.grifter_authenticate_do
-    end
-
-    #TODO: test that ensures grifter_authenticate_do is called
-    #      if Grifter is instantiated with :authenticate => true
-  end
-end

data/spec/http_service_spec.rb

@@ -1,81 +0,0 @@
-require 'grifter/http_service'
-
-describe Grifter::HTTPService do
-
-  let(:test_configuration) do
-    {
-      name: 'test service',
-      hostname: 'totallyfakedomainthatcouldnotpossiblyexist.com',
-      port: 80,
-      ssl: false,
-      ignore_ssl_certificate: false,
-    }
-  end
-
-  before(:each) do
-    @svc = Grifter::HTTPService.new test_configuration
-  end
-
-  describe "http methods" do
-    before(:each) do
-      response = Net::HTTPOK.new('1.1', 200, "stub response body")
-      response.stub(:body).and_return '{"foo": "bar"}'
-      @svc.http.stub!(:request).and_return(response)
-    end
-
-    #methods without a request body
-    [
-      :get,
-      :head,
-      :delete,
-    ].each do |method|
-      it "should have a #{method.to_s} method" do
-        @svc.send(method, '/testing').should be_a Hash
-      end
-    end
-
-    #methods with a json request body
-    [
-      :put,
-      :post,
-    ].each do |method|
-      it "should have a #{method.to_s} method" do
-        @svc.send(method, '/testing', {'a_key' => 'a_value'}).should be_a Hash
-      end
-    end
-
-    it "should remember the last request and response" do
-        @svc.post '/testing', 'a_key' => 'a_value'
-        @svc.last_request.should be_a Net::HTTP::Post
-        @svc.last_response.should be_a Net::HTTPOK
-    end
-  end
-
-  describe "error handling" do
-    before(:each) do
-      response = Net::HTTPBadRequest.new('1.1', 400, "stuff not sure what it does")
-      response.stub(:body).and_return '{"error_code": "400", "error_message": "bad api client, no cookies for you!"}'
-      @svc.http.stub!(:request).and_return(response)
-    end
-
-    it "should raise a RequestException when a 400 is returned" do
-      expect { @svc.get '/testing' }.to raise_error(Grifter::RequestException)
-    end
-  end
-
-  describe "default header configuration" do
-    it "should specification of default headers" do
-      svc = Grifter::HTTPService.new test_configuration.merge default_headers: { 'abc' => '123' }
-      response = Net::HTTPOK.new('1.1', 200, "stub response body")
-      response.stub(:body).and_return '{"foo": "bar"}'
-      svc.http.stub!(:request).and_return(response)
-
-      svc.http.should_receive(:request).with do |req|
-        req['abc'].should eql('123')
-      end
-
-      svc.get '/hello'
-
-    end
-  end
-end

data/spec/json_helpers_spec.rb

@@ -1,77 +0,0 @@
-require 'grifter/json_helpers.rb'
-
-describe Grifter::JsonHelpers do
-
-  let(:json_helper) { Class.new.extend(Grifter::JsonHelpers) }
-
-  describe :jsonify do
-    it "should turn a hash into json" do
-      hash = {
-        'a' => '123',
-        'b' => 456,
-        :c => [
-          1,
-          2.3,
-          '456'
-        ],
-        'd' => {
-          'x' => 'y'
-        }
-      }
-
-      json = json_helper.jsonify(hash)
-
-      #ugh, gross!
-      json.should eql %Q|{
-  "a": "123",
-  "b": 456,
-  "c": [
-    1,
-    2.3,
-    "456"
-  ],
-  "d": {
-    "x": "y"
-  }
-}|
-
-    end
-
-    it "should return a non json string as itself" do
-      json_helper.jsonify("abc").should eql("abc")
-    end
-
-    it "should make a json string pretty" do
-      json_str = '{"foo":"bar", "abc":123}'
-      json_helper.jsonify(json_str).should eql %Q|{
-  "foo": "bar",
-  "abc": 123
-}|
-    end
-
-  end
-
-  describe :objectify do
-    it "should turn a json map string into a Hash" do
-      hsh = {'str' => 'abc', 'int' => 123, 'dec' => 12.34, 'bool' => true}
-      json = JSON.generate hsh
-      json_helper.objectify(json).should eql hsh
-    end
-
-    it "turn a json array string into an Array" do
-      arr = [1, 2.34, 'three', true]
-      json = JSON.generate arr
-      json_helper.objectify(json).should =~ arr
-    end
-
-    it "should return a non-string object as itself" do
-      obj = 12.34
-      json_helper.objectify(obj).should eql obj
-    end
-
-    it "should return a non-json string as itself" do
-      str = 'abc;123'
-      json_helper.objectify(str).should eql str
-    end
-  end
-end

data/spec/resources/example_config.yml

@@ -1,19 +0,0 @@
----
-services:
-  myapi:
-    hostname: 'myapi.com'
-
-  myotherapi:
-    hostname: 'myotherapi.com'
-
-environments:
-  dev:
-    myapi:
-      hostname: 'dev.myapi.com'
-      port: 123  
-
-  staging:
-    myapi:
-      hostname: 'staging.myapi.com'
-      port: 456
-      ignore_ssl_cert: true

data/spec/resources/grifter.yml

@@ -1,11 +0,0 @@
-#base configuration of services goes here
-services:
-  twitter:
-    hostname: 'api.twitter.com'
-    port: 443
-    ssl: true
-    ignore_ssl_cert: false
-    base_uri: '/1.1'
-
-grift_globs:
-  - 'spec/resources/twitter_grifts/**/*_grifts.rb'

data/spec/resources/syntax_error_grifts/eval_error_grifts.rb

@@ -1,3 +0,0 @@
-
-xxx :this_wrong
-

data/spec/resources/twitter_grifts/oauth_grifts.rb

@@ -1,23 +0,0 @@
-require 'base64'
-
-def twitter_keys
-  @_twitter_keys ||= YAML.load_file('example/twitter_grifts/oauth.yml')
-end
-
-def application_authenticate
-  params = { 'grant_type' => 'client_credentials' }
-  token = twitter_keys['consumer_key'] + ':' + twitter_keys['consumer_secret']
-  encoded_token = Base64.strict_encode64(token)
-  response = twitter.post_form '/oauth2/token', params,
-   base_uri: '',
-   additional_headers: {
-     'Authorization' => "Basic " + encoded_token,
-     'Accept' => '*/*',  # I think this is a bug that I have to set it to this:  https://dev.twitter.com/discussions/16348#comment-36465
-   }
-   twitter.headers['Authorization'] = "Bearer #{response['access_token']}"
-   true
-end
-
-def twitter_grift
-  application_authenticate
-end

data/spec/resources/twitter_grifts/timeline_grifts.rb

@@ -1,9 +0,0 @@
-
-def timeline_for screen_name
-  response = twitter.get "/statuses/user_timeline.json?screen_name=#{screen_name}&count=100"
-end
-
-def status_list screen_name
-  timeline = timeline_for screen_name
-  timeline.map {|status| status['text']}
-end

data/spec/rspec_helper_spec.rb

@@ -1,30 +0,0 @@
-require 'grifter'
-require 'grifter/helpers'
-
-describe Grifter::Helpers do
-  describe "including" do
-    it "should be includable" do
-      mod = Module.new do
-        ENV['GRIFTER_CONFIG_FILE'] = 'spec/resources/grifter.yml'
-        include Grifter::Helpers
-      end
-
-      cla = Class.new do
-        extend mod
-      end
-
-      cla.should respond_to :grifter
-
-      #should return the grifter instance if requested
-      cla.grifter.should be_a Grifter
-      cla.grifter.should respond_to :timeline_for
-
-      #but better, all grift methods are just available as is
-      cla.should respond_to :timeline_for
-
-      #the raw services should be available
-      cla.should respond_to :twitter
-      cla.twitter.should respond_to :get
-    end
-  end
-end

data/spec/support/spec_helper.rb

@@ -1,19 +0,0 @@
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  #config.treat_symbols_as_metadata_keys_with_true_values = true
-
-  #setting this to false ensure if we screw up a tag, nothing will run
-  # and we'll know a tag is screwed up.
-  config.run_all_when_everything_filtered = false
-
-  # removing this bit of config as it will interfere with our custom tagging scheme
-  #config.filter_run :focus
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-#  config.order = 'random'
-
-  #config.include TestDataHelpers
-end