omniauth-lokalise 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf2769aac9e539398210793f0fa1f99006f6bce913239e5d4d582b75a1fd1dc8
+  data.tar.gz: 66d92bb92143c7c26c986828079558b8b17b2e4a5458e236828fe9d32fbc77ef
+SHA512:
+  metadata.gz: 843cec4e69000ed694034ebd05b4ba0d4577acb9491495090e57fb9d797b07996cea6b9bc31ef549ecc36ccb1dedef69dd6326d75d9b6889782d8053ba0d3c26
+  data.tar.gz: 8eb255425d01adab6ce5c1d87381a14d50bb424197e7f4197d00764627ae75112e0054821c1ed182b693b3d9ba73efbb2b4197827ca91d1be5cecf5ced0b06f5

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# 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 hello@lokalise.com. The project team will review and investigate all complaints, and will respond in a way that it deems 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/.github/CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Implement your feature or bug fix.
+4. Don't forget to add specs and make sure they pass by running `rspec .`.
+5. Make sure your code complies with the style guide by running `rubocop`. `rubocop -a` can automatically fix most issues for you. Run `rubocop -A` to make it more aggressive.
+6. If necessary, add documentation for your feature or bug fix.
+7. Commit and push your changes.
+8. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-branches
+[pr]: https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
+
+## Previewing the docs locally
+
+1. Clone the repo.
+2. `cd docs`
+3. `bundle exec jekyll serve --baseurl=''`.
+4. Navigate to `http://localhost:4000` and observe the docs.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request. Were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Information
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. 

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.0.1 (28-Apr-22)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 Ilya Krukowski
+
+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,87 @@
+# Omniauth Lokalise
+
+This is an official OmniAuth strategy for [https://lokalise.com](Lokalise).
+
+## Prerequisites
+
+As the first step, you have to register a new OAuth 2 app at Lokalise by contacting the support team and providing the following info:
+
+* Title of your application
+* Logo of your application (150x150px, PNG or JPG)
+* Description of your application (optional)
+* Link to app website/documentation (optional)
+* Required scopes. Find the list required scopes for the corresponding API endpoints in the [Lokalise API docs](https://app.lokalise.com/api2docs/curl/). Please note that your can further adjust these scopes as needed when setting up Omniauth.
+
+After registering, you'll obtain a client ID and client secret. **Do not publicly expose your client secret!**
+
+[*Find detailed information in the Lokalise docs.*](https://docs.lokalise.com/en/articles/5574713-oauth-2)
+
+## Installation
+
+Add a new gem to your `Gemfile`:
+
+```ruby
+gem 'omniauth-lokalise'
+```
+
+Run:
+
+```
+bundle install
+```
+
+## Configuration
+
+Create a new `config/initializers/omniauth.rb` file with the following contents:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :lokalise, 'OAUTH2_CLIENT_ID', 'OAUTH2_CLIENT_SECRET',
+    scope: 'required_scopes'
+end
+```
+
+Paste your client ID, client secret and a list of scopes separated with spaces, for example: `'read_projects write_files'`.
+
+## Usage
+
+Add a login button somewhere in your views (disable Turbo if you use it in your app):
+
+```html
+<%= form_tag('/auth/lokalise', method: 'post', data: {turbo: false}) do %>
+  <button type='submit'>Login with Lokalise</button>
+<% end %>
+```
+
+Create a callback route:
+
+```ruby
+get '/auth/:provider/callback', to: 'sessions#create'
+```
+
+Use `request.env['omniauth.auth']` to fetch OAuth 2 access token and refresh token:
+
+```ruby
+token = request.env['omniauth.auth']['credentials']['token']
+refresh_token = request.env['omniauth.auth']['credentials']['refresh_token']
+```
+
+Please note that currently Lokalise does not provide any information about the logged in user except for credentials. In other words, you can't get access to the user name, uid, email, etc.
+
+## Using refresh token
+
+Access tokens usually expire in 60 minutes but you can request a new one using refresh token. To achieve that, utilize [ruby-lokalise-api](https://github.com/lokalise/ruby-lokalise-api) client:
+
+```ruby
+require 'ruby_lokalise_api'
+
+auth_client = RubyLokaliseApi.auth_client 'OAUTH2_CLIENT_ID', 'OAUTH2_CLIENT_SECRET'
+response = auth_client.refresh 'YOUR_REFRESH_TOKEN'
+token = response['access_token']
+```
+
+## License
+
+This gem is licensed under the [MIT license](./LICENSE).
+
+(c) 2022 Ilya Krukowski

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |task|
+  task.libs << 'test'
+  task.test_files = FileList['test/*_test.rb']
+end
+
+task default: :test

data/lib/omniauth/lokalise/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Lokalise
+    VERSION = '0.0.1'
+  end
+end

data/lib/omniauth/lokalise.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'omniauth/lokalise/version'
+require 'omniauth/strategies/lokalise'

data/lib/omniauth/strategies/lokalise.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class Lokalise < OmniAuth::Strategies::OAuth2
+      option :name, 'lokalise'
+
+      option :client_options, {
+        site: 'https://app.lokalise.com',
+        authorize_url: 'oauth2/auth',
+        token_url: 'oauth2/token',
+        grant_type: 'authorization_code'
+      }
+
+      uid { nil }
+
+      info do
+        {
+          # :name => raw_info['name'],
+          # :email => raw_info['email']
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        # @raw_info ||= access_token.get('/me').parsed
+        {}
+      end
+    end
+  end
+end

data/lib/omniauth-lokalise.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'omniauth/lokalise'

data/spec/omniauth/strategies/lokalise_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe OmniAuth::Strategies::Lokalise do
+  let(:access_token) { instance_double('AccessToken', :options => {}, :[] => 'user') }
+
+  let(:strat) do
+    described_class.new({})
+  end
+
+  before do
+    allow(strat).to receive(:access_token).and_return(access_token)
+  end
+
+  context 'client options' do
+    it 'has correct site' do
+      expect(strat.options.client_options.site).to eq('https://app.lokalise.com')
+    end
+
+    it 'has correct authorize_url' do
+      expect(strat.options.client_options.authorize_url).to eq('oauth2/auth')
+    end
+
+    it 'has correct token_url' do
+      expect(strat.options.client_options.token_url).to eq('oauth2/token')
+    end
+
+    it 'has correct grant_type' do
+      expect(strat.options.client_options.grant_type).to eq('authorization_code')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path(__dir__)
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'rspec'
+
+require 'omniauth'
+require 'omniauth-lokalise'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-lokalise
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ilya Krukowski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Official Omniauth (OAuth 2) strategy for Lokalise TMS
+email:
+- golosizpru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/omniauth-lokalise.rb
+- lib/omniauth/lokalise.rb
+- lib/omniauth/lokalise/version.rb
+- lib/omniauth/strategies/lokalise.rb
+- spec/omniauth/strategies/lokalise_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bodrovis/omniauth-lokalise
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Omniauth strategy for Lokalise
+test_files:
+- spec/omniauth/strategies/lokalise_spec.rb
+- spec/spec_helper.rb