rspec-http-fixtures 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fa13c8900b8be14e148603c8928c5fe8730540117d2bce56a46107d5576fdfa3
+  data.tar.gz: 1a6d27dccc36a5583f5483fc0e28c05e729cb7c5aa88af8ca6fc96156e430621
+SHA512:
+  metadata.gz: 458225bf37a63aca184bd850a34e1efa997242b0a9c2b5ff4e9419f407087e21b2bcc1f3563e20c811319eff3ef038a9ed07a8e8d166269ab9e8b3dcc5ce0b9f
+  data.tar.gz: bc2d35410727954e93a181f54ae8c5c9911e3025c9fd8ba9b5d9eba3874c67dc21abbd6a07ea700e112ea627e86d9cdc3d89f0f827bd7f5985e763bf075b018f

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rspec-http-fixtures.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    rspec-http-fixtures (0.0.1)
+      byebug
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    rake (13.1.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  rspec-http-fixtures!
+
+BUNDLED WITH
+   2.4.20

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 James Hu
+
+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,62 @@
+# rspec-http-fixtures
+
+Provides RSpec helper methods to build HTTP fixtures.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rspec-http-fixtures"
+```
+
+And then execute:
+
+```shell
+bundle install
+```
+
+Or install it yourself as:
+
+```shell
+gem install rspec-http-fixtures
+```
+
+## Usage
+
+Within `rails_helper.rb`
+
+```ruby
+require "rspec-http-fixtures"
+
+RSpec.configure do |config|
+  # Specify where fixtures will be located
+  config.http_fixtures_path = Rails.root.join("spec/fixtures")
+
+
+  # Include helpers that are available within fixtures
+  config.http_fixtures_include FixtureHelpers
+end
+```
+
+Work with fixtures using the following helpers
+
+```ruby
+read_http_fixture("stripe/subscription.json.erb",
+  id: "so_123",
+)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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/axsuul/rspec-http-fixtures.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/rspec-http-fixtures/fixture-namespace.rb

@@ -0,0 +1,92 @@
+module RSpecHTTPFixtures
+  class FixtureNamespace
+    def initialize(context:, path:, params: {})
+      @context = context
+      @path = path
+
+      params.each do |key, value|
+        set(key, value)
+      end
+    end
+
+    def set(key, value)
+      instance_variable_set("@#{key}", value)
+    end
+
+    def build_fixture_path(path)
+      # Can convert relative path to absolute path
+      "#{File.expand_path(path, File.dirname(@path))}.erb"
+    end
+
+    # To be used with arrays and objects for json fixtures and returns the actual data or null if nil
+    def build_json_data(value, default = nil)
+      value ||= default
+
+      build_json_null(value) || (value.is_a?(String) ? value : value.to_json)
+    end
+
+    # Returns string value enclosed in quotes or null if nil for json fixtures. Can also be forced to be null by
+    # passing in the string: "null"
+    def build_json_string(value, default = nil)
+      value ||= default
+
+      # Ensure any double quotes are escaped since they are part of string and won't mess up the entire JSON
+      build_json_null(value) || "\"#{value.to_s.gsub('"', '\"')}\""
+    end
+
+    # Returns integer value or null if nil for json fixtures. Can also be forced to be null by passing in the
+    # string: "null"
+    def build_json_number(value, default = nil)
+      value ||= default
+
+      build_json_null(value) || value
+    end
+
+    # Returns boolean value or null if nil for json fixtures. Can also be forced to be null by passing in the
+    # string: "null". Can provide default if value is nil
+    def build_json_boolean(value, default = nil)
+      return "null" if value == "null"
+      return value unless value.nil?
+
+      default.is_a?(TrueClass) || default.is_a?(FalseClass) ? default : "null"
+    end
+
+    def build_json_iso8601(value, default = nil)
+      value ||= default
+
+      build_json_null(value) || build_json_string(value.is_a?(String) ? value : value.iso8601)
+    end
+
+    def build_json_epoch(value)
+      build_json_number(value&.to_i)
+    end
+
+    def build_json_null(value)
+      value.nil? || value == "null" ? "null" : nil
+    end
+
+    def build_json_collection_fixture(fixture, params_collection = [])
+      @context.build_json_collection_fixture(build_fixture_path(fixture), params_collection)
+    end
+
+    def build_xml_collection_fixture(fixture, params_collection = [])
+      params_collection.map { |p| @context.read_fixture(build_fixture_path(fixture), p) }.join("")
+    end
+
+    # rubocop:disable Style/MethodMissingSuper
+    # rubocop:disable Style/MissingRespondToMissing
+    def method_missing(name, *args)
+      instance_variable = "@#{name}"
+
+      # First try to see if it's a param we're trying to access which is stored in an instance variable otherwise
+      # try to see if there's a method currently on class (from includes)
+      if instance_variable_defined?(instance_variable)
+        instance_variable_get(instance_variable)
+      elsif respond_to?(name)
+        send(name, *args)
+      end
+    end
+    # rubocop:enable Style/MethodMissingSuper
+    # rubocop:enable Style/MissingRespondToMissing
+  end
+end

data/lib/rspec-http-fixtures/helpers.rb

@@ -0,0 +1,55 @@
+require_relative "fixture-namespace"
+
+module RSpecHTTPFixtures
+  module Helpers
+    def build_http_fixture_path(path)
+      RSpec.configuration.http_fixtures_path.join(path)
+    end
+
+    def open_http_fixture(path)
+      File.open(build_http_fixture_path(path))
+    end
+
+    def read_http_fixture(read_http_fixture_path, read_fixture_params = {}, *read_fixture_args)
+      # Copy the params so the original doesn't get mutated
+      read_fixture_params = read_fixture_params.deep_dup
+
+      # If path is a symbol then we can assume it's a method so let's call it Otherwise, we assume it's a relative
+      # path to our fixture. We use long variables since these variables are also of the same scope that is being
+      # passed into the ERB template so we don't want to collide with anything in the namespace
+      read_fixture_body =
+        if read_http_fixture_path.is_a?(Symbol)
+          send(read_http_fixture_path, read_fixture_params, *read_fixture_args)
+        else
+          # Chomp to get rid of newline at end
+          open_http_fixture(read_http_fixture_path).read.chomp
+        end
+
+      # Return raw body unless it is an ERB. If it's ERB, then render it with params
+      return read_fixture_body unless File.extname(read_http_fixture_path.to_s) == ".erb"
+
+      unless read_fixture_params.is_a?(Hash)
+        raise ArgumentError, "params must be a Hash, instead it's #{read_fixture_params.inspect}"
+      end
+
+      # Use ERB to inject variables into body
+      erb = ERB.new(read_fixture_body)
+
+      # We use a custom namespace class so that we can include helper methods
+      # into the namespace to make them available for template to access
+      namespace = FixtureNamespace.new(
+        context: self,
+        path: build_http_fixture_path(read_http_fixture_path),
+        params: read_fixture_params,
+      )
+
+      erb.result(namespace.instance_eval { binding })
+    end
+
+    def build_json_collection_fixture(path, collection_params)
+      return unless collection_params
+
+      collection_params.map { |p| JSON.parse(read_http_fixture(path, p)) }.to_json
+    end
+  end
+end

data/lib/rspec-http-fixtures.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rspec/core"
+require "rspec-http-fixtures/helpers"
+
+RSpec.configure do |config|
+  config.add_setting(:http_fixtures_path, default: nil)
+
+  config.include(RSpecHTTPFixtures::Helpers)
+end
+
+RSpec::Core::Configuration.class_eval do
+  def http_fixtures_include(mod)
+    RSpecHTTPFixtures::FixtureNamespace.class_eval do
+      include(mod)
+    end
+  end
+end

data/rspec-http-fixtures.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "rspec-http-fixtures"
+  spec.version = "0.0.1"
+  spec.authors = ["James Hu"]
+
+  spec.summary = "Capistrano plugin for deploying and managing Nomad jobs"
+  spec.description = "Capistrano plugin for deploying and managing Nomad jobs"
+  spec.homepage = "https://github.com/axsuul/rspec-http-fixtures"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/axsuul/rspec-http-fixtures"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "byebug"
+  spec.add_dependency "rake"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: rspec-http-fixtures
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Hu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Capistrano plugin for deploying and managing Nomad jobs
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rspec-http-fixtures.rb
+- lib/rspec-http-fixtures/fixture-namespace.rb
+- lib/rspec-http-fixtures/helpers.rb
+- rspec-http-fixtures.gemspec
+homepage: https://github.com/axsuul/rspec-http-fixtures
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/axsuul/rspec-http-fixtures
+  source_code_uri: https://github.com/axsuul/rspec-http-fixtures
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Capistrano plugin for deploying and managing Nomad jobs
+test_files: []