response_mate-nanoc 0.0.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGQzNGFkYTMyZjUzMzY0NDAwNGU3ZWFjNjI1MjAyOGQ0YjJjMTEyYw==
+  data.tar.gz: !binary |-
+    ZWE1M2Y2NTBiNzViMDA5NzhiNmE3M2NkMzY1MzU2YTM1ZGVlOTA0Ng==
+SHA512:
+  metadata.gz: !binary |-
+    MjEyNzliNWM3MjIwODA0YjdhYjk1M2RiNDYwNjg3NDY4N2ZjYzA3OTE5NzZh
+    MDM5NGY5YmUyMmZkMGI1NGJiOTFjNjU3ODU5MzY4NWI4YjNlNmU4NjAyZjg2
+    MjQzZmFiYmJkNzZhOGQyNTg4ZmZhM2NmMTQ0YmM5YTk1N2Q1NTE=
+  data.tar.gz: !binary |-
+    ZjdhZTIxOGJlYTRiMTA2NTA4MmFjOGQyN2Y3OGVhOTEwMmNkZmJhNTNiZTM5
+    YzEyMGZlNjJmMDZjMDhkZGU2NWQ3NTQzNzFlZjY2YWE0YzQ5NGFiZGRhYmNj
+    NzFiMjQzZWQxZGEyZDY5ZDYzMDFkZWYxYWJhMjYyMGU5YzI1YjU=

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+source 'https://rubygems.skroutz.gr'
+
+gemspec

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+desc 'Run RSpec'
+RSpec::Core::RakeTask.new(:test) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format nested']
+end
+
+task :default => :test

data/lib/response_mate/nanoc.rb

@@ -0,0 +1,4 @@
+require 'active_support/all'
+
+require 'response_mate/nanoc/version'
+require 'response_mate/nanoc/formatter'

data/lib/response_mate/nanoc/formatter.rb

@@ -0,0 +1,152 @@
+require 'yaml'
+
+module ResponseMate
+  module Nanoc
+    module Formatter
+      FILTERED_PARAMS = [:oauth_token]
+
+      def recordings_path
+        ResponseMate.configuration.output_dir
+      end
+
+      # @param recording_key <String, Symbol> the key matching a recording in
+      # recordings
+      # @param options [Hash] options for rendering
+      # @option options [Array] :only defines which elements should be created
+      # The possible values are:
+      # :request -> creates html with request verb, path and params used
+      # :description -> creates html with description specified in recordings
+      # file (under :meta => :description key)
+      # :status -> The response status code (200, 400 etc)
+      # :body -> The actual response body
+      #
+      # @return html for the specified recording
+      def render_recording(recording_key, options = {})
+        recording = load_recording(recording_key)
+
+        if !options[:only]
+          options[:only] = [:request, :description, :status, :body]
+        end
+
+        result = '<div class="example">'
+        result << format_request(recording) if options[:only].include?(:request)
+        result << add_toggler
+        result << format_description(recording) if options[:only].include?(:description)
+        result << format_response(recording, options)
+        result << '</div>'
+
+        result
+      end
+
+      def load_recording(key)
+        filename = File.join(recordings_path, "#{key}.yml")
+
+        if !File.exists?(filename)
+          raise "#{key} key was not found. Try Running `response_mate record`."\
+            "Use `response_mate list recordings` to view available keys"
+        end
+
+        recording = YAML.load_file(filename)
+
+        recording.symbolize_keys
+      end
+
+      def json(key)
+        hash = case key
+          when Hash
+            h = {}
+            key.each { |k, v| h[k.to_s] = v }
+            h
+          when Array
+            key
+          else Resources.const_get(key.to_s.upcase)
+        end
+
+        hash = yield hash if block_given?
+
+        %(<pre class="highlight"><code class="language-javascript">) +
+          JSON.pretty_generate(hash) + "</code></pre>"
+      end
+
+      def prepared_response(key)
+        response = YAML.load_file("./output/responses/#{key}.yml")
+        headers_output = headers(response[:status])
+        body_content = JSON.pretty_generate(JSON.parse(response[:body]))
+        body_output = %(<pre class="highlight"><code class="language-javascript">) +
+          body_content + "</code></pre>"
+
+        headers_output + body_output
+      end
+
+      def text_html(response, status, head = {})
+        hs = headers(status, head.merge('Content-Type' => 'text/html'))
+        res = CGI.escapeHTML(response)
+        hs + %(<pre class="highlight"><code>) + res + "</code></pre>"
+      end
+
+      def headers(status, head = {})
+        css_class = (status == 204 || status == 404) ? 'headers no-response' : 'headers'
+        lines = ["Status: #{ResponseMate::Http::STATUS_CODES[status]}"]
+        %(<pre class="#{css_class}"><code>#{lines * "\n"}</code></pre>\n)
+      end
+
+      private
+
+      def format_request(recording)
+        <<-OUT
+        <p class="request">
+          <span class="verb">#{recording[:request][:verb]}</span>
+          <span class="path">#{recording[:request][:path]}</span>
+        </p>
+        OUT
+      end
+
+      def add_toggler
+        '<a href="javascript:void(0)" class="toggler" data-target="js-response">view response</a>'
+      end
+
+      def format_response(recording, options)
+        out = '<div class="response">'
+        out << format_status(recording) if options[:only].include?(:status)
+        out << format_body(recording)   if options[:only].include?(:body)
+        out << '</div>'
+      end
+
+      def format_params(hash)
+        output = '<ul class="request-params">'
+
+        output << hash.map { |k, v|
+          val = v.is_a?(Hash) ? format_params(v) : v
+          val = '[FILTERED]' if FILTERED_PARAMS.include? k.to_sym
+
+          "<li><span class=\"label\">#{k}</span>: #{val}</li>"
+        }.join()
+        output << "</ul>"
+
+      end
+
+      def format_status(recording)
+        %(<pre class="headers"><code>Status: #{recording[:status]}</code></pre>\n)
+      end
+
+      def format_body(recording)
+        begin
+          content = JSON.pretty_generate(JSON.parse(recording[:body]))
+        rescue JSON::ParserError
+          content = recording[:body]
+        end
+        %(<pre class="highlight body"><code class="language-javascript">%s</code></pre>) %
+          content
+      end
+
+      def format_description(recording)
+        return '' if !recording[:meta] || !recording[:meta][:description]
+
+        description = recording[:meta][:description]
+
+        "<div class='request-description'> Description: #{description}</div>"
+      end
+    end end
+end
+
+include ResponseMate::Nanoc::Formatter

data/lib/response_mate/nanoc/version.rb

@@ -0,0 +1,5 @@
+module ResponseMate
+  module  Nanoc
+    VERSION = '0.0.7'
+  end
+end

data/response_mate-nanoc.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+require File.expand_path('../lib/response_mate/nanoc/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'response_mate-nanoc'
+  s.version       = ResponseMate::Nanoc::VERSION
+  s.date          = '2012-12-20'
+  s.summary       = %{ResponseMate for nanoc}
+  s.description   = %{Helpers and formatters for displaying ResponseMate output in nanoc}
+  s.authors       = ['Dimitris Karakasilis', 'Dimitris Zorbas']
+  s.email         = 'jimmykarily@gmail.com'
+  s.files         = `git ls-files`.split($\)
+  s.homepage      = ''
+  s.license       = 'MIT'
+
+  s.add_runtime_dependency 'activesupport'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'pry'
+  s.add_development_dependency 'pry-nav'
+  s.add_development_dependency 'rspec', '~> 2.14'
+
+  s.add_dependency 'response_mate', '~> 0.1.6'
+end

data/spec/fixtures/recordings/invalid_yml.yml

@@ -0,0 +1,2 @@
+some_key: %this is not valid yaml
+

data/spec/fixtures/recordings/skus_index.yml

@@ -0,0 +1,31 @@
+:request:
+  :verb: GET
+  :path: /skus
+  :params:
+    page: '1'
+    per: '3'
+    oauth_token: Vr/AzbfQt3ywQlKUonZk25VqRg2ILFAFV/voi69FD9xlJl5Yp9DmDWb6PAEsVwuI1KckH3aa1/vxRaj/Mbwg==
+:status: 200
+:headers:
+  link: <http://localhost:3000/api/skus?oauth_token=Vr%2FAzbfQt3ywQlKUonZk25VqRg2ILFAFV%2Fvoi69FD9xlJl5Yp9DmDWb6PAEsVwuI1KckH3aa1%2FvxRaj%2FMbwg%3D%3D&page=474564&per=3>;
+    rel="last", <http://localhost:3000/api/skus?oauth_token=Vr%2FAzbfQt3ywQlKUonZk25VqRg2ILFAFV%2Fvoi69FD9xlJl5Yp9DmDWb6PAEsVwuI1KckH3aa1%2FvxRaj%2FMbwg%3D%3D&page=2&per=3>;
+    rel="next"
+  content-type: application/json; charset=utf-8
+  x-meta-request-version: 0.2.1
+  x-ua-compatible: IE=Edge,chrome=1
+  etag: ! '"168c0d9677583c8305fb51b0543f1dda"'
+  cache-control: max-age=0, private, must-revalidate
+  x-request-id: c217576d97a588517f360dd1790e6e4b
+  x-runtime: '0.834211'
+  server: WEBrick/1.3.1 (Ruby/1.9.3/2012-11-10)
+  date: Fri, 20 Dec 2013 10:53:52 GMT
+  content-length: '2281'
+  connection: close
+  set-cookie: locale=el_GR; path=/, _helmet_couch=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJWFmM2E1MjE1ZGVkYzNiNjIyYTZiMWMzNjQ5YTMyNmEzBjsAVEkiC2xvY2FsZQY7AFRJIgplbF9HUgY7AEY%3D--c4ff9c59b2235dba4ecb1e94450af6d37846d791;
+    path=/; expires=Thu, 20-Feb-2014 10:53:52 GMT; HttpOnly
+:body: ! '{"skus":[{"id":224,"ean":"","pn":"","name":"H 500","display_name":"Motorola
+  H 500","category_id":435,"first_product_shop_info":"870|Media-ram","click_url":null,"price_max":47.71,"price_min":32.63,"reviewscore":0.0,"shop_count":1,"plain_spec_summary":null,"active_products_count":1,"main_picture":{"small_url":"http://d.scdn.gr/images/sku_main_images/000000/224/small_Motorola-H-500.jpeg","original_url":"http://b.scdn.gr/images/sku_main_images/000000/224/medium_Motorola-H-500.jpeg","tiny_url":"http://a.scdn.gr/images/sku_main_images/000000/224/tiny_Motorola-H-500.jpeg","medium_url":"http://b.scdn.gr/images/sku_main_images/000000/224/medium_Motorola-H-500.jpeg","datamart_url":"http://b.scdn.gr/images/sku_main_images/000000/224/Motorola-H-500.jpeg"},"manufacturer_id":27},{"id":403,"ean":null,"pn":null,"name":"T-104","display_name":"Brother
+  T-104","category_id":66,"first_product_shop_info":null,"click_url":null,"price_max":73.9,"price_min":69.9,"reviewscore":0.0,"shop_count":3,"plain_spec_summary":null,"active_products_count":3,"main_picture":{"small_url":"http://d.scdn.gr/images/sku_main_images/000000/403/small_Brother-T-104.jpeg","original_url":"http://c.scdn.gr/images/sku_main_images/000000/403/medium_Brother-T-104.jpeg","tiny_url":"http://b.scdn.gr/images/sku_main_images/000000/403/tiny_Brother-T-104.jpeg","medium_url":"http://c.scdn.gr/images/sku_main_images/000000/403/medium_Brother-T-104.jpeg","datamart_url":"http://c.scdn.gr/images/sku_main_images/000000/403/Brother-T-104.jpeg"},"manufacturer_id":46},{"id":404,"ean":null,"pn":null,"name":"T-106","display_name":"Brother
+  T-106","category_id":66,"first_product_shop_info":null,"click_url":null,"price_max":122.9,"price_min":122.0,"reviewscore":0.0,"shop_count":2,"plain_spec_summary":null,"active_products_count":2,"main_picture":{"small_url":"http://c.scdn.gr/images/sku_main_images/000000/404/small_Brother-T-106.jpeg","original_url":"http://d.scdn.gr/images/sku_main_images/000000/404/medium_Brother-T-106.jpeg","tiny_url":"http://c.scdn.gr/images/sku_main_images/000000/404/tiny_Brother-T-106.jpeg","medium_url":"http://d.scdn.gr/images/sku_main_images/000000/404/medium_Brother-T-106.jpeg","datamart_url":"http://c.scdn.gr/images/sku_main_images/000000/404/Brother-T-106.jpeg"},"manufacturer_id":46}]}'
+:meta:
+  :description: This is the description

data/spec/fixtures/recordings/skus_index_with_string_body.yml

@@ -0,0 +1,28 @@
+:request:
+  :verb: GET
+  :path: /skus
+  :params:
+    page: '1'
+    per: '3'
+    oauth_token: Vr/AzbfQt3ywQlKUonZk25VqRg2ILFAFV/voi69FD9xlJl5Yp9DmDWb6PAEsVwuI1KckH3aa1/vxRaj/Mbwg==
+:status: 200
+:headers:
+  link: <http://localhost:3000/api/skus?oauth_token=Vr%2FAzbfQt3ywQlKUonZk25VqRg2ILFAFV%2Fvoi69FD9xlJl5Yp9DmDWb6PAEsVwuI1KckH3aa1%2FvxRaj%2FMbwg%3D%3D&page=474564&per=3>;
+    rel="last", <http://localhost:3000/api/skus?oauth_token=Vr%2FAzbfQt3ywQlKUonZk25VqRg2ILFAFV%2Fvoi69FD9xlJl5Yp9DmDWb6PAEsVwuI1KckH3aa1%2FvxRaj%2FMbwg%3D%3D&page=2&per=3>;
+    rel="next"
+  content-type: application/json; charset=utf-8
+  x-meta-request-version: 0.2.1
+  x-ua-compatible: IE=Edge,chrome=1
+  etag: ! '"168c0d9677583c8305fb51b0543f1dda"'
+  cache-control: max-age=0, private, must-revalidate
+  x-request-id: c217576d97a588517f360dd1790e6e4b
+  x-runtime: '0.834211'
+  server: WEBrick/1.3.1 (Ruby/1.9.3/2012-11-10)
+  date: Fri, 20 Dec 2013 10:53:52 GMT
+  content-length: '2281'
+  connection: close
+  set-cookie: locale=el_GR; path=/, _helmet_couch=BAh7B0kiD3Nlc3Npb25faWQGOgZFRkkiJWFmM2E1MjE1ZGVkYzNiNjIyYTZiMWMzNjQ5YTMyNmEzBjsAVEkiC2xvY2FsZQY7AFRJIgplbF9HUgY7AEY%3D--c4ff9c59b2235dba4ecb1e94450af6d37846d791;
+    path=/; expires=Thu, 20-Feb-2014 10:53:52 GMT; HttpOnly
+:body: This is a string body
+:meta:
+  :description: This is the description

data/spec/lib/response_mate/nanoc/formatter_spec.rb

@@ -0,0 +1,119 @@
+require 'spec_helper'
+
+describe ResponseMate::Nanoc::Formatter do
+  let(:recordings_path) do
+    File.join(fixtures_path, 'recordings')
+  end
+
+  before do
+    ResponseMate::Configuration.any_instance.stub(:output_dir).
+      and_return(recordings_path)
+  end
+
+  describe "#load_recording" do
+    context "when the requested key does not exist" do
+      let(:key) { :non_existent_recording }
+
+      it "raises error" do
+        expect {
+          load_recording(key)
+        }.to raise_error(/key was not found/)
+      end
+    end
+
+    context "when the requested key exists" do
+      context "when it does not match a valid yml file" do
+        let(:key) { :invalid_yml }
+
+        it "raises error" do
+          expect {
+            load_recording(key)
+          }.to raise_error(/invalid_yml\.yml/)
+        end
+      end
+
+      context "when it matches a valid yml file" do
+        let(:key) { :skus_index }
+
+        it "doesn't raise error" do
+          expect {
+            load_recording(key)
+          }.to_not raise_error
+        end
+
+        it "returns the file parsed" do
+          expect(load_recording(key)).to eq(
+            YAML.load_file(
+              File.join(recordings_path, "#{key}.yml")
+            ).symbolize_keys
+          )
+        end
+      end
+    end
+  end
+
+  describe "#render_recording" do
+    let(:key) { :skus_index }
+
+    it "calls load_recording with the same key" do
+      should_receive(:load_recording).with(:skus_index).and_call_original
+
+      render_recording(:skus_index)
+    end
+
+    context "when :request exists in options[:only]" do
+      let(:options) { { only: [:request] } }
+
+      it "renders request from yaml file" do
+        render_recording(key, options).should match(/verb.*path.*params/)
+      end
+    end
+
+    context "when :status exists in options[:only]" do
+      let(:options) { { only: [:status] } }
+
+      it "renders status from yaml file" do
+        render_recording(key, options).should match(/Status: 200/)
+      end
+    end
+
+    context "when :description exists in options[:only]" do
+      let(:options) { { only: [:description] } }
+
+      it "renders description from yaml file" do
+        render_recording(key, options).should match(/This is the description/)
+      end
+    end
+
+    context "when :body exists in options[:only]" do
+      let(:options) { { only: [:body] } }
+
+      context "when body is a string" do
+        let(:key) { :skus_index_with_string_body }
+
+        it "renders body" do
+          subject.render_recording(key, options).should match(/This is a string body/)
+        end
+      end
+
+      context "when body is JSON" do
+        it "renders body prettyfied" do
+          expected_string =
+            JSON.pretty_generate(
+              JSON.parse(subject.load_recording(key)[:body]))
+
+          subject.render_recording(key, options).should match(
+            /#{Regexp.escape(expected_string)}/)
+        end
+      end
+    end
+
+    context "more that one key exist in options[:only]" do
+      let(:options) { { only: [:request, :status] } }
+
+      it "renders all keys" do
+        subject.render_recording(key, options).should match(/verb.*path.*params.*Status: 200/)
+      end
+    end
+  end
+end

data/spec/lib/response_mate/nanoc_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe ResponseMate::Nanoc do
+  it 'has a version number' do
+    expect(ResponseMate::Nanoc::VERSION).to be_present
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'response_mate'
+require 'response_mate/nanoc'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :documentation # :progress, :html, :textmate
+end
+
+def fixtures_path
+  File.expand_path('spec/fixtures')
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: response_mate-nanoc
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Dimitris Karakasilis
+- Dimitris Zorbas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: response_mate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: Helpers and formatters for displaying ResponseMate output in nanoc
+email: jimmykarily@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/response_mate/nanoc.rb
+- lib/response_mate/nanoc/formatter.rb
+- lib/response_mate/nanoc/version.rb
+- response_mate-nanoc.gemspec
+- spec/fixtures/recordings/invalid_yml.yml
+- spec/fixtures/recordings/skus_index.yml
+- spec/fixtures/recordings/skus_index_with_string_body.yml
+- spec/lib/response_mate/nanoc/formatter_spec.rb
+- spec/lib/response_mate/nanoc_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1.9
+signing_key: 
+specification_version: 4
+summary: ResponseMate for nanoc
+test_files: []
+has_rdoc: