omnibucket 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 486ccabb2cb4cf5bc2da50ff5ee328e48fe2794fcfef2d00da9bf04447da32e0
-  data.tar.gz: c9684c8cc04c7e8865fad2a693165a807c92d5062ebc766bdbc311ad2691fb6c
+  metadata.gz: 690ea30a126f7be550a15a8a09984a63cc9bac631adc42bf1ddbd8217f51f5c9
+  data.tar.gz: 5f8cddfc8969c1d1c258c05d6c5166d7baa1459adf03c9c1ea21d337b458dc1b
 SHA512:
-  metadata.gz: c6509c0956f12a27caba2c6c18562e746238e582421913255fd5d7759d7c0d2a0fe18a8d0302f2371a5035b80dbe3d5d81c161668e7added06ef7ca553d2303a
-  data.tar.gz: f1a60fc170c396528382a6f67ac5955ae561a77b5857ed2d2e1050e20c19adf0364a30b0960d166358f15ca591468d126dad7651f7dff526eaebeb23a32e446c
+  metadata.gz: 380e363277fae53054c04d1d09af9b5739f9c2f10ad02b7ac95bc0abcb680edea295cfc741b10b19320e5c39c41a13066489170400c050571f404411a98fc187
+  data.tar.gz: 433a4cea4777b07220c6c555bc2897ca97bae93163f8755936cab875521d9db62591d005c67e37f03870f9ddb1c0ee44b1ae61720d9fe3c63f3de5036d923f72

data/README.md

@@ -1,7 +1,42 @@
 [![Build Status](https://travis-ci.org/ylaguna/omnibucket.svg?branch=master)](https://travis-ci.org/ylaguna/omnibucket)
 [![Coverage Status](https://coveralls.io/repos/github/ylaguna/omnibucket/badge.svg?branch=master)](https://coveralls.io/github/ylaguna/omnibucket?branch=master)
 
+#Omnibucket
 
-# omnibucket
+## Installation
 
-Bitbucket's OAuth2 Strategy for OmniAuth. This strategy uses API 2.0 to retrieve user information.
+Add this line to your application's Gemfile:
+
+    gem 'omnibucket'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+`OmniAuth::Strategies::Bitbucket` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: <https://github.com/intridea/omniauth>.
+
+First, create a new application at `https://bitbucket.org/account/user/<your username>/api`. Your callback URL must be something like `https://example.com/auth/bitbucket/callback`. For development you can use `http://127.0.0.1:3000/auth/bitbucket/callback`.
+
+Here's a quick example, adding the middleware to a Rails app in `config/initializers/omniauth.rb`. This example assumes you're exporting your credentials as environment variables.
+
+Notice that we'll always inject `account` and `emails` scopes, so we can retrieve the required information.
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :bitbucket,
+            ENV['BITBUCKET_CLIENT_ID'],
+            ENV['BITBUCKET_CLIENT_SECRET']
+end
+```
+
+Now visit `/auth/bitbucket` to start authentication against Bitbucket.
+
+## Contributing
+
+1. Fork [omnibucket](https://github.com/ylaguna/omnibucket/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/omniauth-bitbucket/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Bitbucket
-    VERSION = "0.2.0".freeze
+    VERSION = "0.2.1".freeze
   end
 end

data/omnibucket.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["yan.laguna@gmail.com"]
   spec.summary       = "A fork from Nando Vieira's omniauth-atlassian-bitbucket"
   spec.description   = spec.summary
-  spec.homepage      = "https://github.com/ylaguna/omniauth-atlassian-bitbucket"
+  spec.homepage      = "https://github.com/ylaguna/omnibucket"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: omnibucket
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Yan Laguna
@@ -145,7 +145,7 @@ files:
 - test/omniauth/strategies/client_options_test.rb
 - test/omniauth/strategies/data_test.rb
 - test/test_helper.rb
-homepage: https://github.com/ylaguna/omniauth-atlassian-bitbucket
+homepage: https://github.com/ylaguna/omnibucket
 licenses:
 - MIT
 metadata: {}