ApiPattern

A base set of ops for all my API clients to make maintenance easier

Installation

Add this line to your application's Gemfile:

gem 'api_pattern'

And then execute:

$ bundle

Or install it yourself as:

$ gem install api-pattern

Usage

Only unauthorised calls

  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

  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.

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 code of conduct.

License

The gem is available as open source under the terms of the MIT License.

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.

TRex22/api-pattern