beze 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b6d584889f587c985651c1a0cbed7e78fcd5749c9d3c8efa87cc8edc56b74ac4
+  data.tar.gz: c49296c79872869e4f581c916859077d63e8ba2198aeb3057d78645d68391b3e
+SHA512:
+  metadata.gz: 244d4bb0dacd16f9dabd8453ecc766f999b7bef7bda22a10998f3e721ad15ece97da97e4527f801403786e5fc7c9d9925a2fcb217482a74ff350baa318576e8c
+  data.tar.gz: ab3704f86d0210ec2a1546380cf5d6a774dcf42c03d3d20827c3368b250ebea78bf9266a8f2719b91099b94ca10e5afacc25130639143cf5e9f8b36498cde94a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Released]
+
+## [0.1.0] - 2022-04-20
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in beze.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Sylvance
+
+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,40 @@
+# Beze
+
+Spicy beze gem.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add beze
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install beze
+
+## Usage
+
+To use this;
+
+```ruby
+Beze.create_resource(:[resource_name], payload, options)
+Beze.delete_resource(:[resource_name], payload, options)
+Beze.get_resource(:[resource_name], payload, options)
+Beze.list_resource(:[resource_name], payload, options)
+Beze.update_resource(:[resource_name], payload, options)
+Beze.patch_resource(;[resource_name], payload, options)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 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/bezefy/beze.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/beze.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/beze/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "beze"
+  spec.version = Beze::VERSION
+  spec.authors = ["Sylvance"]
+  spec.email = ["103753399+ninjawork@users.noreply.github.com"]
+
+  spec.summary = "Spicy beze gem."
+  spec.description = "Spicy beze gem"
+  spec.homepage = "https://github.com/bezefy/beze"
+  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/bezefy/beze"
+  spec.metadata["changelog_uri"] = "https://github.com/bezefy/beze/blob/main/CHANGELOG.md"
+
+  # 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 "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/beze/client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "http_client"
+
+# Ruby gem that helps you work with Beze API.
+module Beze
+  # Client that acts as a middleman to the API.
+  class Client
+    # Class to display Beze result
+    class BezeResult
+      attr_accessor :result, :message
+
+      def initialize(result:, message:)
+        @result = result
+        @message = message
+      end
+    end
+
+    # Class to display error result
+    class BezeErrorResult
+      attr_accessor :result, :message
+
+      def initialize(result:, message:)
+        @result = result
+        @message = message
+      end
+    end
+
+    attr_reader :resource, :payload, :options
+
+    def self.call(resource:, payload:, options:)
+      new(resource, payload, options).call
+    end
+
+    def initialize(resource, payload, options)
+      @resource = resource
+      @payload  = payload
+      @options  = options
+    end
+
+    def call
+      body    = payload
+      headers = options[:headers]
+      params  = options[:params]
+      uri     = "#{Beze::BASE_URL}/#{Beze.configuration.api_version}/#{resource}/#{options[:uri]}"
+
+      http_call = Beze::HttpClient.call(body: body, headers: headers, method: method, params: params, uri: uri)
+
+      if http_call.successful?
+        BezesResult.new(result: http_call, message: "Successful call to endpoint. #{http_call.result.message}")
+      else
+        BezeErrorResult.new(result: http_call, message: "Failure while calling endpoint. #{http_call.result.message}")
+      end
+    end
+  end
+end
+

data/lib/beze/http_client.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "uri"
+require "net/http"
+require "openssl"
+require "ostruct"
+require "json"
+
+# Ruby gem that helps you work with Bezefy API.
+module Beze
+  # Http client that acts as a middleman to the API.
+  class HttpClient
+    NET_HTTP_ERRORS = [
+      Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, EOFError,
+      Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError,
+      JSON::ParserError, SocketError
+    ].freeze
+
+    def self.call(method:, uri:, body: nil, params: nil, headers: nil, expect: nil)
+      new(method, uri, body, params, headers, expect).call
+    end
+
+    def initialize(method, uri, body, params, headers, expect)
+      @method  = method
+      @body    = body
+      @headers = headers
+      @url     = prepare_uri(uri, params)
+      @expect  = expect.nil? ? :json : expect
+      @http    = prepare_http
+      @request = prepare_request
+    end
+
+    def call
+      response
+    end
+
+    private
+
+    attr_accessor :body, :expect, :headers, :http, :method, :request, :url
+
+    def response
+      http_response = http.request(request)
+
+      if http_response.is_a?(Net::HTTPSuccess)
+        result = Beze.to_ostruct(JSON.parse(http_response.read_body)) if expect == :json
+        result = http_response.read_body if expect == :html
+        result_struct(result, http_response, true)
+      else
+        result_struct(nil, http_response, false)
+      end
+    rescue *NET_HTTP_ERRORS => e
+      result_struct(e, http_response, false)
+    end
+
+    def result_struct(result, response, success)
+      OpenStruct.new(
+        result: result,
+        headers: Beze.to_ostruct(response.to_hash),
+        code: response.code,
+        message: response.message,
+        class: response.class.name,
+        successful?: success
+      )
+    end
+
+    def prepare_uri(uri, params)
+      build_url = URI(uri)
+      build_url.query = URI.encode_www_form(params) unless params.nil?
+      build_url
+    end
+
+    def prepare_http
+      protocol = Net::HTTP.new(url.host, url.port)
+      protocol.use_ssl = true
+      protocol.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      protocol
+    end
+
+    def prepare_request
+      req = build_request
+      req.basic_auth(Beze.configuration.app_email, Beze.configuration.app_password)
+      req.body = JSON.dump(body) unless body.nil?
+      req
+    end
+
+    def build_request
+      return Net::HTTP::Get.new(url, headers)     if method == :get
+      return Net::HTTP::Post.new(url, headers)    if method == :post
+      return Net::HTTP::Put.new(url, headers)     if method == :put
+      return Net::HTTP::Patch.new(url, headers)   if method == :patch
+      return Net::HTTP::Delete.new(url, headers)  if method == :delete
+      return Net::HTTP::Options.new(url, headers) if method == :options
+    end
+  end
+end
+

data/lib/beze/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Beze
+  VERSION = "0.1.0"
+end

data/lib/beze.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+require_relative "beze/client"
+require_relative "beze/http_client"
+require_relative "beze/version"
+
+module Beze
+  BASE_URL = ENV.fetch('API_BASE_URL') || "http://localhost:3000"
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= OpenStruct.new(api_version: nil, app_email: nil, app_password: nil)
+  end
+
+  def self.create_resource(resource, payload, options)
+    Beze::Client.call(resource: resource, payload: payload, options: options, method: :post)
+  end
+
+  def self.get_resource(resource, payload, options)
+    Beze::Client.call(resource: resource, payload: payload, options: options, method: :get)
+  end
+
+  def self.list_resource(resource, payload, options)
+    Beze::Client.call(resource: resource, payload: payload, options: options, method: :get)
+  end
+
+  def self.update_resource(resource, payload, options)
+    Beze::Client.call(resource: resource, payload: payload, options: options, method: :put)
+  end
+
+  def self.patch_resource(resource, payload, options)
+    Beze::Client.call(resource: resource, payload: payload, options: options, method: :patch)
+  end
+
+  def self.delete_resource(resource, payload, options)
+    Beze::Client.call(resource: resource, payload: payload, options: options, method: :delete)
+  end
+
+  def self.to_ostruct(input)
+    result = {}
+
+    if input.is_a?(Hash)
+      result["type"] = input.class
+      result["keys"] = input.keys
+
+      input.each do |key, value|
+        result[key] = hash_or_array(value) ? to_ostruct(value) : OpenStruct.new(value: value, type: value.class)
+      end
+    end
+
+    if input.is_a?(Array)
+      result["type"] = input.class
+      result["size"] = input.size
+
+      input.each.with_index do |value, index|
+        result["value_at_#{index}"] = hash_or_array(value) ? to_ostruct(value) : OpenStruct.new(value: value, type: value.class)
+      end
+    end
+
+    OpenStruct.new(result)
+  end
+
+  def self.hash_or_array(val)
+    val.is_a?(Hash) || val.is_a?(Array)
+  end
+end
+

data/sig/beze.rbs

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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: beze
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sylvance
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-20 00:00:00.000000000 Z
+dependencies: []
+description: Spicy beze gem
+email:
+- 103753399+ninjawork@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- beze.gemspec
+- lib/beze.rb
+- lib/beze/client.rb
+- lib/beze/http_client.rb
+- lib/beze/version.rb
+- sig/beze.rbs
+homepage: https://github.com/bezefy/beze
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/bezefy/beze
+  source_code_uri: https://github.com/bezefy/beze
+  changelog_uri: https://github.com/bezefy/beze/blob/main/CHANGELOG.md
+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.22
+signing_key:
+specification_version: 4
+summary: Spicy beze gem.
+test_files: []