beeceptor_ruby 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e9e3123b36ab28fe28bfa3af99de2946153ae5c8a0881bb6eeb9c84902f3832
+  data.tar.gz: 84de13f378c7da98c4966d5a19107ac53a10fa36cce0b88dd206279a5ab67e6b
+SHA512:
+  metadata.gz: 6cde750ced5a59cdd1f4057d278260f2314d6dd0ca91569722975300af78a48a6a99963182a96847874b1d0e640c70e3fb370659583f5fd22747c2f28a564b46
+  data.tar.gz: 97548adb9ec831fae51fea5b6f79bcca4206b28e20c719b9436c467ec9a3ee9062c8407f0365891ca2d7ddf3c8828e712c3301e1152f9b2f0edb2fabc1374634

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.2.0] - 2022-12-15
+
+- Initial release

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in beeceptor_ruby.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Chris Davis
+
+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,47 @@
+# BeeceptorRuby
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add beeceptor_ruby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install beeceptor_ruby
+
+## Usage
+
+This gem provides access to the Beeceptor REST API.
+
+```ruby
+require 'beeceptor_ruby'
+
+options = {
+  :api_key  => 'YOUR_API_KEY',
+  :endpoint => 'YOUR_ENDPOINT'
+}
+
+client = BeeceptorRuby::Client.new(options)
+
+puts client.list_rules
+```
+
+## Beeceptor REST API Documentation
+- [Overview](https://docs.beeceptor.com/docs/api-overview/)
+- [Rules](https://docs.beeceptor.com/docs/features-mocking-rules/)
+- [History](https://docs.beeceptor.com/docs/api-request-history/)
+
+## 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/[USERNAME]/beeceptor_ruby.
+
+## 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/beeceptor_ruby/client.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'resource/history'
+require_relative 'resource/rules'
+require 'faraday'
+require 'json'
+
+module BeeceptorRuby
+  # Client provides methods for interacting with all beeceptor
+  # features i.e. mocking rules and api request
+  class Client
+    include BeeceptorRuby::Client::Resource::History
+    include BeeceptorRuby::Client::Resource::Rules
+
+    def initialize(options)
+      @base_url = "https://api.beeceptor.com/api/v1/endpoints/#{options[:endpoint]}"
+      @api_key = options[:api_key]
+      @client = Faraday.new(@base_url, builder: build_middleware) do |http|
+        http.headers[:content_type] = 'application/json'
+        http.headers[:authorization] = @api_key
+      end
+    end
+
+    attr_reader :base_url
+
+    def request(method, path, params = {}, headers = {})
+      path = URI.parse("#{@base_url}#{path}").normalize.to_s
+      @client.send(method, path, params, headers)
+    end
+
+    def build_middleware
+      Faraday::RackBuilder.new do |builder|
+        builder.response :json
+      end
+    end
+  end
+end

data/lib/beeceptor_ruby/resource/history.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BeeceptorRuby
+  class Client
+    module Resource
+      # The History API can be used to retrieve and manage request history
+      module History
+        def get_request(request_id)
+          request :get, "/requests/#{request_id}"
+        end
+
+        def list_requests
+          request :get, '/requests'
+        end
+
+        def purge_request(request_id)
+          request :delete, "/requests/#{request_id}"
+        end
+
+        def purge_requests
+          request :delete, '/requests'
+        end
+      end
+    end
+  end
+end

data/lib/beeceptor_ruby/resource/rules.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module BeeceptorRuby
+  class Client
+    module Resource
+      # The Rules API can be used to create, retrieve, update and delete mocking rules
+      module Rules
+        def create_rule(body)
+          request :post, '/rules', body
+        end
+
+        def get_rule(rule_id)
+          request :get, "/rules/#{rule_id}"
+        end
+
+        def list_rules
+          request :get, '/rules'
+        end
+
+        def update_rule(rule_id, body)
+          request :put, "/rules/#{rule_id}", body
+        end
+
+        def delete_rule(rule_id)
+          request :delete, "/rules/#{rule_id}"
+        end
+      end
+    end
+  end
+end

data/lib/beeceptor_ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BeeceptorRuby
+  VERSION = '0.2.0'
+end

data/lib/beeceptor_ruby.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'beeceptor_ruby/version'
+require_relative 'beeceptor_ruby/client'
+
+module BeeceptorRuby
+  class Error < StandardError; end
+end

data/sig/beeceptor_ruby.rbs

@@ -0,0 +1,4 @@
+module BeeceptorRuby
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: beeceptor_ruby
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Chris Davis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: json
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Allows users to use Beeceptor's REST API.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/beeceptor_ruby.rb
+- lib/beeceptor_ruby/client.rb
+- lib/beeceptor_ruby/resource/history.rb
+- lib/beeceptor_ruby/resource/rules.rb
+- lib/beeceptor_ruby/version.rb
+- sig/beeceptor_ruby.rbs
+homepage: https://github.com/bodyshopbidsdotcom/beeceptor_ruby
+licenses:
+- MIT
+metadata: {}
+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.2.33
+signing_key:
+specification_version: 4
+summary: Beeceptor REST API Client for Ruby
+test_files: []