grifter 0.0.4

data/spec/configuration_spec.rb

@@ -0,0 +1,127 @@
+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

@@ -0,0 +1,52 @@
+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

@@ -0,0 +1,81 @@
+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

@@ -0,0 +1,53 @@
+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
+end

data/spec/resources/example_config.yml

@@ -0,0 +1,19 @@
+---
+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

@@ -0,0 +1,11 @@
+#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

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

data/spec/resources/twitter_grifts/oauth_grifts.rb

@@ -0,0 +1,23 @@
+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

@@ -0,0 +1,9 @@
+
+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

@@ -0,0 +1,30 @@
+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

@@ -0,0 +1,19 @@
+# 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

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: grifter
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Robert Schultheis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: awesome_print
+  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: jeweler
+  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: convention based approach to interfacing with an HTTP JSON API.
+email: rob@knewton.com
+executables:
+- grift
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+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
+homepage: http://github.com/knewton/grifter
+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'
+      segments:
+      - 0
+      hash: 95742656892023611
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Make calls to HTTP JSON APIs with ease and confidence
+test_files: []