api_pattern 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b824d5027294a5fbec1ae0b376da2e1031527c930aec4d70ba6924efbc1b3750
+  data.tar.gz: 8ec7712914d9d528de5fea6ff78bc618d0e6245da5ef0fb71475334510d168e8
+SHA512:
+  metadata.gz: 06ede13830d1bd225cc84484c3a1aa5c6d7f723c6e32c010e27bc0c1cdefe09f1b892bdedd22d7e18fb507ac411afad7346a50103b6aeb607b426bd82f74e710
+  data.tar.gz: 9a414a4e91c7413d430fe3e059b9eb7ff5ccb407197c4b2a358a379b81151c181a364f1613b46e28b2fcc83f5148a4ba98372fd30f4304dcff66544a4748f703

data/.github/workflows/ruby-ci.yml

@@ -0,0 +1,24 @@
+name: Ruby Tests
+
+on: [push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2.2
+    - name: Cache dependencies
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: v1-${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          v1-${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at contact@jasonchalom.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/TRex22/api-pattern" }
+
+# Specify your gem's dependencies in api-pattern.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,119 @@
+PATH
+  remote: .
+  specs:
+    api_pattern (0.0.1)
+      active_attr (~> 0.15.4)
+      httparty (~> 0.21.0)
+      nokogiri (~> 1.14.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.4.3)
+      actionview (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.4.3)
+      activesupport (= 7.0.4.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    active_attr (0.15.4)
+      actionpack (>= 3.0.2, < 7.1)
+      activemodel (>= 3.0.2, < 7.1)
+      activesupport (>= 3.0.2, < 7.1)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.4)
+      public_suffix (>= 2.0.2, < 6.0)
+    ansi (1.5.0)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.2)
+    crack (0.4.5)
+      rexml
+    crass (1.0.6)
+    erubi (1.12.0)
+    hashdiff (1.0.1)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.20.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.8.1)
+    minitest (5.18.0)
+    minitest-focus (1.3.1)
+      minitest (>= 4, < 6)
+    minitest-reporters (1.6.0)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    mocha (2.0.2)
+      ruby2_keywords (>= 0.0.5)
+    multi_xml (0.6.0)
+    nokogiri (1.14.3)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.14.3-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.3-x86_64-linux)
+      racc (~> 1.4)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (5.0.1)
+    racc (1.6.2)
+    rack (2.2.6.4)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    rake (13.0.6)
+    rexml (3.2.5)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    timecop (0.9.6)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+  arm64-darwin-22
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  api_pattern!
+  minitest (~> 5.18.0)
+  minitest-focus (~> 1.3.1)
+  minitest-reporters (~> 1.6.0)
+  mocha (~> 2.0.2)
+  pry (~> 0.14.2)
+  rake (~> 13.0.6)
+  timecop (~> 0.9.6)
+  webmock (~> 3.18.1)
+
+BUNDLED WITH
+   2.3.16

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Jason Chalom
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 trex22
+
+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,114 @@
+# ApiPattern
+A base set of ops for all my API clients to make maintenance easier
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api-pattern'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api-pattern
+
+## Usage
+
+### Only unauthorised calls
+```ruby
+  require 'api-pattern'
+
+  class ExampleClient < ApiClient::Client
+    def self.compatible_api_version
+      'v1'
+    end
+
+    def self.api_version
+      'v1 2023-04-24'
+    end
+
+    def example_unauthorised_get
+      unauthorised_and_send(http_method: :get, path: "messages")
+    end
+
+    def example_unauthorised_post(payload)
+      unauthorised_and_send(http_method: :post, path: "users", payload: payload)
+    end
+  end
+
+  client = ExampleClient.new(
+    content_type: "application/json",
+    base_path: "https://example.com",
+    port: 443
+  )
+
+  client.example_unauthorised_get
+```
+
+### Using authorised calls
+```ruby
+  require 'api-pattern'
+
+  class ExampleClient < ApiClient::Client
+    def self.compatible_api_version
+      'v1'
+    end
+
+    def self.api_version
+      'v1 2023-04-24'
+    end
+
+    def example_authorised_get
+      authorised_and_send(http_method: :get, path: "messages")
+    end
+
+    def example_authorised_post(payload)
+      authorised_and_send(http_method: :post, path: "users", payload: payload)
+    end
+  end
+
+  client = ExampleClient.new(
+    token: "abc123",
+    content_type: "application/json",
+    base_path: "https://example.com",
+    port: 443
+  )
+
+  client.example_unauthorised_get
+```
+
+## Upgrades
+Make sure to run:
+
+```
+bundle lock --add-platform x86_64-linux
+bundle lock --add-platform ruby
+```
+
+## 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).
+
+### Tests
+To run tests execute:
+
+    $ rake test
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/api-pattern. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the api-pattern: project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/trex22/api-pattern/blob/master/CODE_OF_CONDUCT.md).

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/api-pattern.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "api-pattern/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_pattern"
+  spec.version       = ApiPattern::VERSION
+  spec.authors       = ["trex22"]
+  spec.email         = ["contact@jasonchalom.com"]
+
+  spec.summary       = "A client for using the ApiPattern API in Ruby."
+  spec.description   = "A client for using the ApiPattern API in Ruby. Built from their api documentation. This is an unofficial project."
+  spec.homepage      = "https://github.com/TRex22/ApiPattern"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.21.0"
+  spec.add_dependency "active_attr", "~> 0.15.4"
+  spec.add_dependency "nokogiri", "~> 1.14.3"
+
+  # Development dependancies
+  spec.add_development_dependency "rake", "~> 13.0.6"
+  spec.add_development_dependency "minitest", "~> 5.18.0"
+  spec.add_development_dependency "minitest-focus", "~> 1.3.1"
+  spec.add_development_dependency "minitest-reporters", "~> 1.6.0"
+  spec.add_development_dependency "timecop", "~> 0.9.6"
+  spec.add_development_dependency "mocha", "~> 2.0.2"
+  spec.add_development_dependency "pry", "~> 0.14.2"
+  spec.add_development_dependency "webmock", "~> 3.18.1"
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api-pattern"
+
+# 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

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/api-pattern/class_helpers.rb

@@ -0,0 +1,52 @@
+# ClassHelpers
+# Used to give some of the quality of life methods Rails would usually provide
+# TODO: May need to evaluate using these
+class Hash
+  def with_indifferent_access
+    dup.with_indifferent_access!
+  end
+
+  def with_indifferent_access!
+    keys.each { |key| resolve(key) }
+
+    self
+  end
+
+  def present?
+    !blank?
+  end
+
+  def blank?
+    nil? || self == {}
+  end
+
+  private
+
+  def resolve(key)
+    if self[key].is_a?(Hash)
+      self[key.to_s] = delete(key).with_indifferent_access!
+    else
+      self[key.to_s] = delete(key)
+    end
+  end
+end
+
+class String
+  def present?
+    !blank?
+  end
+
+  def blank?
+    nil? || self == "" || self == ""
+  end
+end
+
+class NilClass
+  def present?
+    !blank?
+  end
+
+  def blank?
+    nil?
+  end
+end

data/lib/api-pattern/client.rb

@@ -0,0 +1,198 @@
+module ApiPattern
+  class Client
+    include ::ApiPattern::Constants
+
+    attr_reader :base_path, :port, :content_type, :limit
+
+    # Other auth parameters may be removed in the future
+    # For now making sure this base is compatible with all my API clients
+    attr_reader :auth, :auth_type
+    attr_reader :token
+    attr_reader :username, :key
+    attr_reader :password, :secret
+
+    # Response instance variables
+    attr_reader :login_response, :raw_cookie, :expiry
+
+    def initialize(base_path:, content_type:, port: BASE_PORT, auth: EMPTY_AUTH, auth_type: DEFAULT_AUTH_TYPE, token: EMPTY_PARAMETER, api_token: EMPTY_PARAMETER, access_token: EMPTY_PARAMETER, username: EMPTY_PARAMETER, key: EMPTY_PARAMETER, password: EMPTY_PARAMETER, secret: EMPTY_PARAMETER, limit: EMPTY_PARAMETER)
+      process_auth(auth, auth_type, token, api_token, access_token, username, key, password, secret)
+
+      @content_type = content_type
+      @base_path = base_path
+      @port = port
+      @limit = limit
+    end
+
+    def self.compatible_api_version
+      raise NotImplementedError
+    end
+
+    # This is the version of the API docs this client was built off-of
+    def self.api_version
+      raise NotImplementedError
+    end
+
+    private
+
+    def unauthorised_and_send(http_method:, path:, payload: {}, params: {}, format: :json)
+      start_time = get_micro_second_time
+
+      response = ::HTTParty.send(
+        http_method.to_sym,
+        construct_base_path(path, params),
+        body: process_payload(payload),
+        headers: {
+          "Content-Type": @content_type,
+        },
+        port: port,
+        format: format,
+      )
+
+      end_time = get_micro_second_time
+      construct_response_object(response, path, start_time, end_time)
+    end
+
+    def authorise_and_send(http_method:, path:, payload: {}, params: {}, format: :json)
+      start_time = get_micro_second_time
+
+      send_params = {
+        body: process_payload(payload),
+        headers: {
+          "Content-Type": @content_type
+        },
+        port: port,
+        format: format,
+      }
+
+      response = ::HTTParty.send(
+        http_method.to_sym,
+        construct_base_path(path, params),
+        **configure_auth(send_params)
+      )
+
+      end_time = get_micro_second_time
+      construct_response_object(response, path, start_time, end_time)
+    end
+
+    def construct_response_object(response, path, start_time, end_time)
+      {
+        "body" => parse_body(response, path),
+        "headers" => response.headers,
+        "metadata" => construct_metadata(response, start_time, end_time)
+      }
+    end
+
+    def construct_metadata(response, start_time, end_time)
+      total_time = end_time - start_time
+
+      {
+        "start_time" => start_time,
+        "end_time" => end_time,
+        "total_time" => total_time
+      }
+    end
+
+    def body_is_present?(response)
+      !body_is_missing?(response)
+    end
+
+    def body_is_missing?(response)
+      response.body.nil? || response.body.empty?
+    end
+
+    def parse_body(response, path)
+      parsed_response = JSON.parse(response.body) # Purposely not using HTTParty
+
+      if parsed_response.dig(path.to_s)
+        parsed_response.dig(path.to_s)
+      else
+        parsed_response
+      end
+    rescue JSON::ParserError => _e
+      response.body
+    end
+
+    def get_micro_second_time
+      (Time.now.to_f * 1_000_000).to_i
+    end
+
+    def construct_base_path(path, params)
+      constructed_path = "#{base_path}/#{path}"
+
+      if params == {}
+        constructed_path
+      else
+        "#{constructed_path}?#{process_params(params)}"
+      end
+    end
+
+    def process_payload(payload)
+      if @content_type.to_s.downcase.include?("json")
+        payload.to_json
+      else
+        payload
+      end
+    end
+
+    def process_params(params)
+      params.keys.map { |key| "#{key}=#{params[key]}" }.join("&")
+    end
+
+    def process_auth(auth, auth_type, token, api_token, access_token, username, key, password, secret)
+      @auth = auth || {}
+      @auth_type = auth_type
+
+      if token.present? || api_token.present? || access_token.present?
+        @auth["token"] = token || api_token || access_token
+
+        @auth_type = "token"
+        @token = token || api_token || access_token
+      elsif username.present? && password.present?
+        @auth["username"] = username
+        @auth["password"] = password
+
+        basic_auth(username, password)
+      elsif key.present? && secret.present?
+        @key = key
+        @secret = secret
+
+        basic_auth(key, secret)
+      end
+    end
+
+    def basic_auth(username, password)
+      @auth["username"] = username
+      @auth["password"] = password
+
+      @auth_type = "basic"
+      @username = username
+      @password = password
+    end
+
+    # Need to use symbols here to HTTParty named parameters
+    def configure_auth(send_params)
+      if @auth_type == "token"
+        headers = send_params[:headers]
+        headers["Token"] = @auth["token"]
+        send_params[:headers] = headers
+      elsif @auth_type == "basic"
+        send_params[:basic_auth] = @auth # { username: "", password: "" }
+      end
+
+      # TODO: Using aliases for the sending
+      # TODO: Basic auth via body
+      # TODO: Separate login flow
+
+      send_params
+    end
+
+    # https://stackoverflow.com/questions/913349/what-is-the-best-way-to-create-alias-to-attributes-in-ruby
+    def alias_attr(new_attr, original)
+      alias_method(new_attr, original) if method_defined? original
+
+      new_writer = "#{new_attr}="
+      original_writer = "#{original}="
+      alias_method(new_writer, original_writer) if method_defined? original_writer
+    end
+  end
+end

data/lib/api-pattern/constants.rb

@@ -0,0 +1,16 @@
+module ApiPattern
+  module Constants
+    BASE_PORT = 80
+
+    DEFAULT_AUTH_TYPE = "basic"
+    EMPTY_AUTH = {}
+    EMPTY_PARAMETER = nil
+
+    AUTH_TYPES = {
+      none: 0,
+      basic: 1,
+      token: 2,
+      oauth: 3,
+    }
+  end
+end

data/lib/api-pattern/version.rb

@@ -0,0 +1,3 @@
+module ApiPattern
+  VERSION = "0.0.1"
+end

data/lib/api-pattern.rb

@@ -0,0 +1,13 @@
+require "httparty"
+require "nokogiri"
+
+require "api-pattern/class_helpers"
+
+require "api-pattern/version"
+require "api-pattern/constants"
+
+require "api-pattern/client"
+
+module ApiPattern
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification
+name: api_pattern
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- trex22
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: active_attr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.14.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.18.0
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.6
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.18.1
+description: A client for using the ApiPattern API in Ruby. Built from their api documentation.
+  This is an unofficial project.
+email:
+- contact@jasonchalom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby-ci.yml"
+- ".gitignore"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- api-pattern.gemspec
+- bin/console
+- bin/setup
+- lib/api-pattern.rb
+- lib/api-pattern/class_helpers.rb
+- lib/api-pattern/client.rb
+- lib/api-pattern/constants.rb
+- lib/api-pattern/version.rb
+homepage: https://github.com/TRex22/ApiPattern
+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: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: A client for using the ApiPattern API in Ruby.
+test_files: []