omniauth-zendesk_sell 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8bc47feb9e892b9bb9305b0c2500822f484f52d6dc6aa15e3c3829aba00f88c
+  data.tar.gz: '0729cf3804ef06e722aec8b725152617db08e9e9e5d374b90358b7cf801effcf'
+SHA512:
+  metadata.gz: e9160acaf940fa403f5fe261c1639623ee715ded47c7088baa5437786ce4732f411326b927fdb08b016c8365b6dab16da76ebd33df0137499fdc8c75e0366b07
+  data.tar.gz: 47eb4c083216d8b8e07bdbe49c8249d1b063a43686a5d2844afa6848c47a4dfcc693decaadd510c1cbcb22216404cc77a59c2c25e7e5186b9dea90a49b51b0f7

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

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 jr180180@gmail.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-zendesk_sell.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    omniauth-zendesk_sell (1.0.0)
+      omniauth-oauth2 (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    hashie (4.1.0)
+    jwt (2.2.2)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.4)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.9.1)
+      hashie (>= 3.4.6)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.7.0)
+      oauth2 (~> 1.4)
+      omniauth (~> 1.9)
+    rack (2.2.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-zendesk_sell!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 John
+
+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,89 @@
+# Omniauth::ZendeskSell
+
+See more information on the Zendesk Sell OAuth2 authentication at https://developers.getbase.com/docs/rest/articles/oauth2/introduction
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-zendesk_sell'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install omniauth-zendesk_sell
+
+## Setup
+
+1\. Create an `omniauth.rb` initializer file and add this as provider:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :zendesk_sell,
+           ENV['ZENDESK_SELL_CLIENT_ID'],
+           ENV['ZENDESK_SELL_CLIENT_SECRET'],
+           scope: 'read write profile'
+end
+```
+
+Scope details can be found at: https://developers.getbase.com/docs/rest/articles/oauth2/introduction#scopes
+
+2\. Add your callback route and whitelist while registering your app at https://app.futuresimple.com/settings/oauth/apps
+
+Your callback route will look something like this: `https://your_domain.com/auth/zendesk_sell/callback`
+
+3\. Start/restart your application and go to GET `https://your_domain.com/auth/zendesk_sell` to begin the authentication process.
+
+4\. In your controller, use the following to get the callback request data:
+
+```ruby
+request.env['omniauth.auth']
+```
+
+Here's an example of the data structure returned from the request call above:
+
+```ruby
+{ "provider"    => "zendesk_sell",
+  "uid"         => 11111,
+  "info"        => { "name" => "your_account_name", "email" => nil },
+  "credentials" =>
+    { "token"         => "1237918237829",
+      "refresh_token" => "1237918237829",
+      "expires_at"    => 1237918237829,
+      "expires"       => true },
+  "extra"       =>
+    { "raw_info" =>
+        { "id"          => 11111,
+          "name"        => "your_account_name",
+          "time_format" => "12H",
+          "timezone"    => "UTC-05:00",
+          "created_at"  => "2020-01-11T11:11:11Z",
+          "updated_at"  => "2020-11-11T11:11:11Z",
+          "currency"    => "USD",
+          "phone"       => "1111111111" } } }
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jr180180/omniauth-zendesk_sell. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/jr180180/omniauth-zendesk_sell/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 Omniauth::ZendeskSell project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jr180180/omniauth-zendesk_sell/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/zendesk_sell"
+
+# 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
+
+require "irb"
+IRB.start(__FILE__)

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/omniauth-zendesk_sell.rb

@@ -0,0 +1 @@
+require "omniauth/zendesk_sell"

data/lib/omniauth/strategies/zendesk_sell.rb

@@ -0,0 +1,36 @@
+require 'omniauth-oauth2'
+
+module OmniAuth
+  module Strategies
+    class ZendeskSell < OmniAuth::Strategies::OAuth2
+      option :name, "zendesk_sell"
+      option :client_options, {
+        site:          'https://api.getbase.com',
+        authorize_url: 'oauth2/authorize',
+        token_url:     'oauth2/token',
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          name:  raw_info['name'],
+        }
+      end
+
+      extra do
+        {
+          'raw_info' => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/v2/accounts/self').parsed['data']
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/lib/omniauth/zendesk_sell.rb

@@ -0,0 +1,2 @@
+require "omniauth/zendesk_sell/version"
+require "omniauth/strategies/zendesk_sell"

data/lib/omniauth/zendesk_sell/version.rb

@@ -0,0 +1,5 @@
+module Omniauth
+  module ZendeskSell
+    VERSION = "1.0.0"
+  end
+end

data/omniauth-zendesk_sell.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/omniauth/zendesk_sell/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-zendesk_sell"
+  spec.version       = Omniauth::ZendeskSell::VERSION
+  spec.authors       = ["John Sanchez"]
+  spec.email         = ["jr180180@gmail.com"]
+
+  spec.summary       = %q{Zendesk Sell strategy for OmniAuth}
+  spec.description   = %q{Zendesk Sell strategy for OmniAuth}
+  spec.homepage      = "https://github.com/jr180180/omniauth-zendesk_sell"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # 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_runtime_dependency 'omniauth-oauth2', '~> 1.7'
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-zendesk_sell
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Sanchez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+description: Zendesk Sell strategy for OmniAuth
+email:
+- jr180180@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-zendesk_sell.rb
+- lib/omniauth/strategies/zendesk_sell.rb
+- lib/omniauth/zendesk_sell.rb
+- lib/omniauth/zendesk_sell/version.rb
+- omniauth-zendesk_sell.gemspec
+homepage: https://github.com/jr180180/omniauth-zendesk_sell
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jr180180/omniauth-zendesk_sell
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.9
+signing_key:
+specification_version: 4
+summary: Zendesk Sell strategy for OmniAuth
+test_files: []