json-rigs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b948986d7f1dda5f386391f83ce52c3d342a8194
+  data.tar.gz: b51936d4af268f96f9e406765ceee41e3ad6853b
+SHA512:
+  metadata.gz: 5cc7e5c4611ea393849553308c28f2d4aea01a7b9ffa2bed214d984325db825f6c2cf249a99ea2c280aba04510a4ead2881a6e4b94b05215b32522728510297f
+  data.tar.gz: aecb7b4a6f6f41317b14ad83bcafc86e0abc12d75822ee29e534012a66a29af5c24def2d6662943dfc9b2e9b56288ef0caff984ef00004500e9c13a134cc00b5

data/bin/jrigs

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+
+require 'daemons'
+require 'json-rigs/server'
+
+OPTIONS = {
+  app_name: 'json-rigs',
+  dir: '/tmp/',
+  dir_mode: :normal
+}
+cwd = File.join(Dir.pwd, 'fixtures')
+
+Daemons.run_proc('json-rigs', OPTIONS) do
+  JsonRigs::FixtureServerRunner.start(cwd)
+end
+

data/lib/json-rigs/client.rb

@@ -0,0 +1,72 @@
+require 'net/http'
+require 'spec/fixture_server/constants'
+
+module JsonRigs
+  module FixtureClient
+    class << self
+      FIXTURE_URI = '/fixtures'
+
+      def clear_active_fixtures
+        data = {
+          :fixture_action => 'clear'
+        }
+        post_fixture(data)
+      end
+
+      def set_fixture url, method, action, fixture
+        data = {
+          :url => url,
+          :method => method,
+          :action => action,
+          :fixture => fixture,
+          :fixture_action => 'set'
+        }
+        response = post_fixture(data)
+
+        if response.body.length > 0
+          puts "Fixture server error: #{response.body}"
+        end
+      end
+
+      def fixtures
+        data = {
+          :fixture_action => 'get'
+        }
+        response = get_fixture(data)
+
+        if response.body.length > 0
+          puts "Fixture server error: #{response.body}"
+        end
+
+        puts response.body
+
+        JSON.parse(response.body)
+      end
+
+      private
+
+      def get_conn
+        begin
+          Net::HTTP.new('localhost', File.read(JsonRigs::PORT_FILE).to_i)
+        rescue Errno::ENOENT
+          fail "Failed to find fixture server port file #{JsonRigs::PORT_FILE}. Maybe your fixture server is down."
+        end
+      end
+
+      def get_fixture(data)
+        path = FIXTURE_URI.dup
+        path << '?' << data.map { |k, v| "#{k}=#{CGI::escape(v.to_s)}" }.join('&')
+        request = Net::HTTP::Get.new(path)
+
+        get_conn.request(request)
+      end
+
+      def post_fixture(data)
+        request = Net::HTTP::Post.new(FIXTURE_URI)
+        request.set_form_data(data)
+
+        get_conn.request(request)
+      end
+    end
+  end
+end

data/lib/json-rigs/fixture-templates.rb

@@ -0,0 +1,22 @@
+module JsonRigs
+  module FixtureTemplates
+    def basic_post_fixture
+      fixture :success do
+        respond_with %q(
+{
+    "success": true
+}
+        )
+      end
+
+      fixture :failure do
+        respond_with %q(
+{
+    "error_code": 0, 
+    "success": false
+}
+        )
+      end
+    end
+  end
+end

data/lib/json-rigs/fixture.rb

@@ -0,0 +1,51 @@
+require 'json-rigs/fixture-templates'
+
+module JsonRigs
+  class Fixture
+
+    attr_accessor :pause_time
+    attr_reader :response
+
+    def respond_with response
+      JSON.parse(response)
+      @response = response
+    end
+
+    alias_method :delay, :pause_time=
+  end
+
+  class FixturedAction
+    include JsonRigs::FixtureTemplates
+
+    attr_reader :fixtures, :url 
+    attr_accessor :active_fixture_name
+
+    def initialize(url, method)
+      @active_fixture_name = nil
+      @url = url
+      @method = method
+      @fixtures = {}
+    end
+
+    def fixture fixture_name, &block
+      fixture = Fixture.new
+      @fixtures[fixture_name.to_s] = fixture
+      fixture.instance_eval &block
+      @active_fixture_name = ''
+    end
+
+    def active_fixture; @fixtures[@active_fixture_name] end
+    def active_fixture?; !@active_fixture_name.empty? end
+
+    def to_hash
+      fixture_hash = @fixtures.keys.each_with_object({}) do |fixture_name, hash|
+        hash[fixture_name] = @active_fixture_name == fixture_name
+      end
+
+      {
+        method: @method,
+        fixtures: fixture_hash
+      }
+    end
+  end
+end

data/lib/json-rigs/fixtures.rb

@@ -0,0 +1,72 @@
+require 'json'
+
+require 'json-rigs/fixture'
+
+module JsonRigs
+  module Fixtures
+    FixturedActionKey = Struct.new(:url, :method)
+    ACTIVE_FIXTURE_FILE = 'tmp/active_fixtures.json'
+
+    def self.fixture_action(url, method, &block)
+      method = method.to_s
+      @actions ||= {}
+
+      key = _key(url, method)
+      fixture_action = @actions[key] || FixturedAction.new(url, method)
+      @actions[key] = fixture_action
+      fixture_action.instance_eval &block
+    end
+
+    def self.find_action(url, method)
+      method = method.to_s
+      @actions ||= {}
+      @actions[_key(url, method)]
+    end
+
+    def self.clear_active_fixtures
+      @actions.values.each do |action|
+        action.active_fixture_name = ''
+      end
+    end
+
+    def self.save_active_fixtures
+      active_fixtures = @actions.map { |key, action|
+        [ key.url, key.method, action.active_fixture_name ]
+      }
+      FileUtils.mkdir_p(File.dirname(ACTIVE_FIXTURE_FILE))
+      File.open(ACTIVE_FIXTURE_FILE, 'w') { |io| io.write(active_fixtures.to_json) }
+    end
+
+    def self.load_active_fixtures
+      begin
+        active_fixtures = JSON.parse(File.read(ACTIVE_FIXTURE_FILE))
+      rescue Errno::ENOENT, Errno::ESRCH
+        return
+      end
+
+      active_fixtures.each do |fixture|
+        url, method, active_fixture = fixture
+        action = find_action(url, method)
+        if action
+          action.active_fixture_name = active_fixture
+        end
+      end
+    end
+
+    def self.clear_all!
+      @actions = {}
+    end
+
+    def self.fixtures
+      json = @actions.values.group_by(&:url)
+      json.each do |url, actions|
+        json[url] = actions.map(&:to_hash)
+      end
+      json
+    end
+
+    def self._key(url, method)
+      FixturedActionKey.new(url, method)
+    end
+  end
+end

data/lib/json-rigs/server.rb

@@ -0,0 +1,205 @@
+require 'listen'
+require 'sinatra/base'
+require 'socket'
+require 'haml'
+require 'pathname'
+
+require 'json-rigs/fixture'
+require 'json-rigs/fixtures'
+
+module JsonRigs
+  class FixtureServer < Sinatra::Base
+    configure :production, :development do
+      enable :logging
+    end
+
+    def self.load_fixtures
+      puts "Loading fixtures from #{settings.fixture_path}..."
+      Dir[File.join(settings.fixture_path, '**/*.json')].each do |f|
+        load_fixture(f)
+      end
+    end
+
+    def self.load_fixture(f)
+      puts "Loading #{f}..."
+      relevant_path = f.sub(/\A#{settings.fixture_path}/, '')
+      pieces = Pathname(relevant_path).each_filename.to_a
+
+      unless pieces.length >= 2
+        error_message = %Q(
+          Fixtures are not structured correctly.
+          Please place .json files inside #{settings.fixture_path} as /[url]/[HTTP method]/[response type].json, e.g. /users/GET/success.json
+        )
+        logger.error error_message
+        halt error_message
+      end
+
+      url = pieces[0...-2].join('/')
+      method = pieces[-2]
+      response_name = File.basename(pieces[-1], ".*")
+      contents = File.read(f)
+      JsonRigs::Fixtures::fixture_action url, method do
+        fixture response_name.to_sym do
+          respond_with(contents)
+        end
+      end
+    end
+
+    helpers do
+      def serve_request(servlet_url, method)
+        action = JsonRigs::Fixtures::find_action(servlet_url, method)
+        halt "unknown action '#{servlet_url} #{method}'" unless action
+
+        logger.info "Responding to #{servlet_url} #{method}"
+
+        if action.active_fixture?
+          logger.info "Using fixture #{action.active_fixture_name.inspect}"
+
+          fixture = action.active_fixture
+          halt 'action has no associated fixture' unless fixture
+
+          if fixture.pause_time
+            logger.info "Sleeping #{fixture.pause_time} seconds.."
+            sleep(fixture.pause_time)
+          end
+
+          content_type 'application/json'
+          return fixture.response
+        else
+          logger.info 'No fixture specified, using stub response.'
+          return '{ "success": false, "error_code": 0 }'
+        end
+      end
+
+      def clear_fixtures
+        JsonRigs::Fixtures::clear_active_fixtures
+        logger.info 'Fixture clear successful.'
+        return 200
+      end
+
+      def get_fixtures
+        JsonRigs::Fixtures::fixtures.to_json
+      end
+
+      def set_active_fixture
+        %w{url method fixture}.each do |arg|
+          value = params[arg]
+          unless value
+            logger.error "missing #{arg} param"
+            halt "missing #{arg} param"
+          end
+        end
+
+        action = JsonRigs::Fixtures::find_action(params[:url], params[:method])
+
+        action_str = "#{params[:url]} #{params[:method]}"
+        unless action
+          logger.error "unknown action #{action_str}"
+          halt "unknown action #{action_str}"
+        end
+        action.active_fixture_name = params[:fixture]
+
+        JsonRigs::Fixtures::save_active_fixtures
+
+        logger.info "Setting fixture for #{action_str} to #{params[:fixture]}"
+
+        return 200
+      end
+    end
+
+    get '/test-panel' do
+      @fixtures = JsonRigs::Fixtures::fixtures
+      haml :test_panel, locals: {fixtures: @fixtures}
+    end
+
+    get '/test-fixtures' do
+      fixture_action = params[:fixture_action]
+      case fixture_action
+      when 'get', nil
+        get_fixtures
+      else
+        halt "unknown fixture action #{fixture_action.inspect}"
+      end
+    end
+
+    post '/test-fixtures' do
+      fixture_action = params[:fixture_action]
+      case fixture_action
+      when 'clear'
+        clear_fixtures
+      when 'set'
+        set_active_fixture
+      else
+        halt "unknown fixture action #{fixture_action.inspect}"
+      end
+    end
+
+    get '/*' do |servlet_url|
+      serve_request(servlet_url, :GET)
+    end
+
+    post '/*' do |servlet_url|
+      serve_request(servlet_url, :POST)
+    end
+
+    put '/*' do |servlet_url|
+      serve_request(servlet_url, :PUT)
+    end
+
+    delete '/*' do |servlet_url|
+      serve_request(servlet_url, :DELETE)
+    end
+  end
+
+  module FixtureServerRunner
+    class << self
+      STARTING_PORT = 3000
+
+      def start(fixture_path)
+        puts 'Starting fixture server...'
+
+        port = choose_port()
+
+        FixtureServer.set(:port, port)
+        FixtureServer.set(:fixture_path, fixture_path)
+        FixtureServer::load_fixtures
+        JsonRigs::Fixtures::load_active_fixtures
+
+        # Start listener on fixture path to reload fixtures if necessary.
+        listener = Listen.to(fixture_path, only: /\.json$/) { |modified, added, removed|
+          on_fixture_change(modified, added, removed)
+        }
+        listener.start
+
+        FixtureServer.run!
+      end
+
+      private
+
+      def on_fixture_change(modified, added, removed)
+        puts 'Reloading fixtures...'
+
+        JsonRigs::Fixtures::clear_all!
+        FixtureServer::load_fixtures
+        JsonRigs::Fixtures::load_active_fixtures
+
+        puts 'Fixtures reloaded.'
+      end
+
+      def choose_port
+        port = STARTING_PORT
+
+        begin
+          server = TCPServer.new(port)
+        rescue Errno::EADDRINUSE
+          port += 1
+          retry
+        ensure
+          server.close if server
+        end
+
+        port
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: json-rigs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Clinkle
+- David Kettler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: An easy way to serve fixtures in response to web requests.Use a handy
+  panel to choose which fixtures to serve. Great for QA and fast prototyping.
+email:
+- alex@clinkle.com
+- 21echoes@gmail.com
+executables:
+- jrigs
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/jrigs
+- lib/json-rigs.rb
+- lib/json-rigs/client.rb
+- lib/json-rigs/fixture-templates.rb
+- lib/json-rigs/fixture.rb
+- lib/json-rigs/fixtures.rb
+- lib/json-rigs/server.rb
+homepage: https://github.com/21echoes/json-rigs
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: "~~ set sail with json-rigs ~~"
+test_files: []