runscope-rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: 205a1ecd9e1143f1625c8f566f3442ef3f8fe925
+  metadata.gz: 751eb3188abc34ad5b2e37126699aca22b185eb2
+SHA512: 
+  data.tar.gz: 35a8b832d41be93d5c19d514140563afa4d815d07f1fa3be9f670499785d38d65ee544b1928e157f3712df51f21cc5918e2d3dbb292a8d006c81796e982be72d
+  metadata.gz: c52460de1cbd0082ca1298c6e0baf2583b9bd9d9f9835e257a0a9b4de81f7e4b3801078853005a805cbce613e5fb05f42403e30aa5510d7ce3ad858fc46d50b9

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,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Christopher Warren
+
+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,56 @@
+# runscope-rb
+
+A gem to quickly get up and running with Runscope in a few lines of code.
+
+runscope-rb currently supports Net::HTTP requests. Requests made using other HTTP libraries, such as libcurl or sockets, won't be modified. If you want to add support for another HTTP library that would be fantastic. See the section on Contributing at the end of the readme.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+  gem 'runscope', '~> 0.0.1'
+
+And then execute:
+
+  $ bundle
+
+Or install it yourself as:
+
+  $ gem install runscope
+
+## Usage
+
+Obviously you'll need a [Runscope](http://runscope.com) account to use this. Then just run the configure block below within your code. If you're making a Rails app you probably want to put it in config/initializers/runscope.rb.
+
+    Runscope.configure do |config|
+      config.bucket  = "abcd1234"
+      config.domains = ["api.stackexchange.com", "api.github.com", /\S+\.desk\.com/]
+    end
+
+## Options
+
+There are a few options to set:
+
+`bucket` *Required*
+
+A string for the bucket key from Runscope. Default is `nil`.
+
+`domains` *Required*
+
+An array of strings and regular expressions to match outbound traffic against. Any requests through Net::HTTP that don't match one of these will pass through unaltered. Default is `[]`.
+
+`enabled`
+
+A boolean to control if Runscope is used at all. Set to `false` to stop using Runscope. Default is `true`.
+
+## Troubleshooting
+
+If your requests aren't being sent through Runscope after you're set up, check how the request is being made. If it's not using Net::HTTP it won't work at this time. Check the section below on Contributing if you want to add support for another HTTP library.
+
+## 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,3 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/lib/ext/net_http.rb

@@ -0,0 +1,17 @@
+require 'net/http'
+require 'net/https'
+
+module Net
+  class HTTP
+
+    def request_with_runscope(request, body=nil, &block)
+      if ::Runscope.monitor?(self.address)
+        @address = ::Runscope.proxy_domain(self.address)
+      end
+      request_without_runscope(request, body, &block)
+    end
+    alias_method :request_without_runscope, :request
+    alias_method :request, :request_with_runscope
+
+  end
+end

data/lib/runscope/configuration.rb

@@ -0,0 +1,41 @@
+module Runscope
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :bucket,
+      :domains,
+      :enabled
+    ]
+
+    # By default, use Runscope
+    DEFAULT_ENABLED = true
+
+    # By default, send no traffic to Runscope
+    DEFAULT_DOMAINS = []
+
+    # By default, don't set a bucket
+    DEFAULT_BUCKET = nil
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    # When this module is extended, set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block
+    def configure
+      yield self
+    end
+
+    # Create a hash of options and their values
+    def options
+      Hash[VALID_OPTIONS_KEYS.map {|key| [key, send(key)] }]
+    end
+
+    def reset
+      self.bucket   = DEFAULT_BUCKET
+      self.domains  = DEFAULT_DOMAINS
+      self.enabled  = DEFAULT_ENABLED
+    end
+  end
+end

data/lib/runscope/version.rb

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

data/lib/runscope.rb

@@ -0,0 +1,40 @@
+require "runscope/version"
+require "runscope/configuration"
+require "ext/net_http"
+
+module Runscope
+  extend Configuration
+
+  def self.version_string
+    "Runscope version #{Runscope::VERSION}"
+  end
+
+  def self.monitor?(address)
+    enabled? && monitor_domain?(address)
+  end
+
+  def self.monitor_domain?(address)
+    raise NoDomainsSetError unless domains
+    domains.any? do |domain|
+      if domain.is_a?(String)
+        address == domain
+      elsif domain.is_a?(Regexp)
+        address =~ domain
+      end
+    end
+  end
+
+  def self.proxy_domain(address)
+    raise BucketNotSetError unless bucket
+    subdomain = address.gsub(".","-")
+    "#{subdomain}-#{bucket}.runscope.net"
+  end
+
+  def self.enabled?
+    Runscope.enabled
+  end
+end
+
+class RunscopeError < StandardError; end
+class BucketNotSetError < RunscopeError; end
+class NoDomainsSetError < RunscopeError; end

data/runscope-rb.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'runscope/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "runscope-rb"
+  spec.version       = Runscope::VERSION
+  spec.authors       = ["Chris Warren"]
+  spec.email         = ["chris@expectless.com"]
+  spec.description   = %q{Start using Runscope to monitor your API traffic in minutes}
+  spec.summary       = %q{Start using Runscope to monitor your API traffic in minutes}
+  spec.homepage      = "http://github.com/chriswarren/runscope-rb"
+  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", "~>2.13.0"
+  spec.add_development_dependency "fakeweb", "~> 1.3.0"
+  spec.add_development_dependency "simplecov"
+end

data/spec/ext/net_http_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Net::HTTP do
+  context "outgoing requests" do
+    before(:each) do
+      @domains = ["api.stackexchange.com", /\S+\.desk\.com/]
+      @bucket = "1234abcd"
+
+      Runscope.configure do |config|
+        config.domains = @domains
+        config.bucket = @bucket
+      end
+    end
+
+    after(:each) do
+      Runscope.reset
+    end
+
+    context "to a url monitored by runscope" do
+      it "should modify a to a url that matches a string" do
+        FakeWeb.register_uri(:get, "http://api-stackexchange-com-#{@bucket}.runscope.net", :body => "test")
+        Net::HTTP.get_response(URI.parse("http://api.stackexchange.com"))
+      end
+
+      it "should modify a request to a url that matches a regexp" do
+        FakeWeb.register_uri(:get, "http://test-desk-com-#{@bucket}.runscope.net", :body => "test")
+        Net::HTTP.get_response(URI.parse("http://test.desk.com"))
+      end
+    end
+
+    context "to a url not monitored by runscope" do
+      it "should not modify a request to a url that doesn't match" do
+        FakeWeb.register_uri(:get, "http://api.twitter.com", :body => "test")
+        Net::HTTP.get_response(URI.parse("http://api.twitter.com"))
+      end
+    end
+  end
+end

data/spec/runscope/configuration_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Runscope::Configuration do
+  after(:each) do
+    Runscope.reset
+  end
+
+  it 'should set options when passed a block' do
+    domains = ["api.stackexchange.com", /\S+\.desk\.com/]
+    bucket = "1234abcd"
+
+    Runscope.configure do |config|
+      config.domains = domains
+      config.bucket = bucket
+    end
+
+    Runscope.enabled.should eq(true)
+    Runscope.domains.should eq(domains)
+    Runscope.bucket.should eq(bucket)
+  end
+end

data/spec/runscope_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Runscope do
+  context "basic methods" do
+    it 'should return correct version string' do
+      Runscope.version_string.should eq("Runscope version #{Runscope::VERSION}")
+    end
+  end
+
+  context 'monitoring' do
+    before(:each) do
+      Runscope.domains = ["api.stackexchange.com", /\S+\.desk\.com/]
+    end
+
+    after(:each) do
+      Runscope.reset
+    end
+
+    context "when enabled" do
+      before(:each) do
+        Runscope.enabled = true
+      end
+
+      it "should be true if the domain is monitored" do
+        Runscope.monitor?("api.stackexchange.com").should eq(true)
+      end
+
+      it "should be false if the domain is not monitored" do
+        Runscope.monitor?("api.twitter.com").should eq(false)
+      end
+    end
+
+    context "when disabled" do
+      before(:each) do
+        Runscope.enabled = false
+      end
+
+      it "should be false if the domain is monitored" do
+        Runscope.monitor?("api.stackexchange.com").should eq(false)
+      end
+
+      it "should be false if the domain is not monitored" do
+        Runscope.monitor?("api.twitter.com").should eq(false)
+      end
+    end
+  end
+
+  context 'matching domains' do
+    before(:each) do
+      Runscope.domains = ["api.stackexchange.com", /\S+\.desk\.com/]
+    end
+
+    it "should match when stored as a string" do
+      Runscope.monitor_domain?("api.stackexchange.com").should eq(true)
+    end
+
+    it "should match when stored as a Regexp" do
+      Runscope.monitor_domain?("test.desk.com").should eq(true)
+    end
+
+    it "should not match domains that aren't set" do
+      Runscope.monitor_domain?("api.twitter.com").should eq(false)
+    end
+
+    it "should raise an error if no domains are set" do
+      Runscope.domains = nil
+      expect {
+        Runscope.monitor_domain?("api.stackexchange.com")
+      }.to raise_error(NoDomainsSetError)
+    end
+  end
+
+  context 'generating a runscope proxy domain' do
+    before(:each) do
+      @bucket = "1234abcd"
+      Runscope.bucket = @bucket
+    end
+
+    it "should return a domain to runscope" do
+      Runscope.proxy_domain("api.stackexchange.com").should
+        eq("api-stackexchange-com-#{@bucket}.runscope.net")
+    end
+
+    it "should raise an error if no bucket is set" do
+      Runscope.bucket = nil
+      expect {
+        Runscope.proxy_domain("api.stackexchange.com")
+      }.to raise_error(BucketNotSetError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'fakeweb'
+require 'runscope'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+  config.order = "random"
+end
+
+FakeWeb.allow_net_connect = false

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: runscope-rb
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris Warren
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id005 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.13.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id005
+  type: :development
+  version_requirements: *id006
+description: Start using Runscope to monitor your API traffic in minutes
+email: 
+- chris@expectless.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ext/net_http.rb
+- lib/runscope.rb
+- lib/runscope/configuration.rb
+- lib/runscope/version.rb
+- runscope-rb.gemspec
+- spec/ext/net_http_spec.rb
+- spec/runscope/configuration_spec.rb
+- spec/runscope_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/chriswarren/runscope-rb
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id005
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id005
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Start using Runscope to monitor your API traffic in minutes
+test_files: 
+- spec/ext/net_http_spec.rb
+- spec/runscope/configuration_spec.rb
+- spec/runscope_spec.rb
+- spec/spec_helper.rb