The project is in a healthy, maintained state
A library to make easily to build integrations
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

BigId Auth's Library for Ruby

Gem Version Build Status

Dev Requirements

  • Ruby: Any version
  • Bundler

Global Installation

gem install flash_integration

Installation for Rails

# Add to the Gemfile
gem 'flash_integration', '~> 0.1.0'

Example - How to extend

module MyApp
  class Connection < Flash::Integration::Connection
    def initialize(base_url: "http://localhost")
      super(base_url: base_url)
    end

    def default_headers
      {
        "Accept":       "application/json",
        "Content-Type": "application/json"
      }
    end
  end
end

Example - How to request

res = @connection.post(
  method: :post,
  url: url,
  params: {},
  headers: {},
  body: body, # except for get
  multipart: multipart # only for post
)
res # Flash::Integration::Response type
res.request
res.status
res.headers
res.body
res.time

Problems?

Please do not directly email any committers with questions or problems. A community is best served when discussions are held in public.

Searching the issues for your problem is also a good idea.

Contributing

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet;
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it;
  • Fork the project;
  • Start a feature/bugfix branch;
  • Commit and push until you are happy with your contribution;
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.;
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

License

Please see LICENSE for licensing details.

Authors

Danilo Carolino, @danilogco / @Quasar-Flash