vcr-archive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df4561f7124c25def97db1155a3e0b2a83b00eaf
+  data.tar.gz: 3f20ddca7ef92064fbcb908483b5828366482af7
+SHA512:
+  metadata.gz: e0eb49a6ff7a09f0bbd11ee563596e7433acfbfd529ff714e91897f1222b3502f7e4b15cfbb98eadd191d9e3d1967d69ce294a208b0b1d810e7dc950ea006604
+  data.tar.gz: 03f220e9803e54fada95b198e2a5ad7e075cf84778303eb251571a3d5a3a0ecbd6ed536a48ea5d32af4b1b0c026c52791566bc7c49c5060b7db742c0888d3e17

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vcr-archive.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Mytton
+
+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,45 @@
+# VCR::Archive
+
+Using this gem causes VCR to record all HTTP interactions into separate files in a predictable directory structure. This allows you to maintain an archive of HTTP responses. It also stores the response body in a separate file for easier diffing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vcr-archive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vcr-archive
+
+## Usage
+
+```ruby
+require 'vcr/archive'
+VCR.use_cassette('path/to/git/repo/archive') do
+  response = open('http://example.org/').read
+  # ...
+end
+```
+
+After running this the response from http://example.org/ will be archived into the directory given as an argument to `VCR.use_cassette`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/everypolitician/vcr-archive.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'vcr/archive'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/vcr/archive/version.rb

@@ -0,0 +1,5 @@
+module VCR
+  module Archive
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/vcr/archive.rb

@@ -0,0 +1,61 @@
+require 'vcr'
+
+require 'vcr/archive/version'
+
+module VCR
+  module Archive
+    class YamlSeparateHtmlSerializer
+      def self.file_extension
+        'archive'
+      end
+
+      def self.serialize(hash)
+        hash
+      end
+
+      def self.deserialize(hash)
+        hash
+      end
+    end
+
+    class YamlSeparateHtmlPersister
+      def self.[](interactions_directory)
+        interactions_directory.sub!(/\.archive$/, '')
+        return nil unless File.directory?(interactions_directory)
+        files = Dir.glob("#{interactions_directory}/**/*.yml")
+        return nil unless files.any?
+        interactions = files.map do |f|
+          meta = YAML.load_file(f)
+          body = File.binread(f.sub(/\.yml$/, '.html'))
+          meta['response']['body']['string'] = body
+          meta
+        end
+        {
+          'http_interactions' => interactions,
+          'recorded_with' => File.binread(File.join(interactions_directory, 'recorded_with.txt')),
+        }
+      end
+
+      def self.[]=(interactions_directory, meta)
+        interactions_directory.sub!(/\.archive$/, '')
+        meta['http_interactions'].each do |interaction|
+          uri = URI.parse(interaction['request']['uri'])
+          path = File.join(interactions_directory, uri.host, Digest::SHA1.hexdigest(uri.to_s))
+          directory = File.dirname(path)
+          FileUtils.mkdir_p(directory) unless File.exist?(directory)
+          body = interaction['response']['body'].delete('string')
+          File.binwrite("#{path}.yml", YAML.dump(interaction))
+          File.binwrite("#{path}.html", body)
+        end
+        File.binwrite(File.join(interactions_directory, 'recorded_with.txt'), meta['recorded_with'])
+      end
+    end
+
+    VCR.configure do |config|
+      config.hook_into :webmock
+      config.cassette_serializers[:yaml_separate_html] = YamlSeparateHtmlSerializer
+      config.cassette_persisters[:yaml_separate_html] = YamlSeparateHtmlPersister
+      config.default_cassette_options = { serialize_with: :yaml_separate_html, persist_with: :yaml_separate_html }
+    end
+  end
+end

data/vcr-archive.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vcr/archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vcr-archive'
+  spec.version       = VCR::Archive::VERSION
+  spec.authors       = ['Chris Mytton']
+  spec.email         = ['chrismytton@gmail.com']
+
+  spec.summary       = 'VCR Serializer and Persister for archiving HTTP requests'
+  spec.homepage      = 'https://github.com/everypolitician/vcr-archive'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'vcr', '~> 3.0.2'
+  spec.add_runtime_dependency 'webmock', '~> 2.0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: vcr-archive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Mytton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- chrismytton@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/vcr/archive.rb
+- lib/vcr/archive/version.rb
+- vcr-archive.gemspec
+homepage: https://github.com/everypolitician/vcr-archive
+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.5.1
+signing_key: 
+specification_version: 4
+summary: VCR Serializer and Persister for archiving HTTP requests
+test_files: []