instant2fa 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 08dc3834cf91694551e139385cf3c8c931a063b9
+  data.tar.gz: 75b4749b3d8b4f1165bf71b52ebab688d9c43daf
+SHA512:
+  metadata.gz: 2ef0b4c316c6321cdab9ce26c526c20f9a2405ce9ec0b5a6e9b35f1492cf11ac99c6d59a43d17e82202c3cbce935023deebd9cce7b82537e86bae1f9fa8c6e9f
+  data.tar.gz: e9b49e825e3a2f66cbd35d83a444991332c9e61b1cbfcc37b73aa342c42563456add4df9755a134bc0bb452fdef9b4b1af3306c6d4318c5b972c2fb77f98d7af

data/.gitignore

@@ -0,0 +1,10 @@
+*.gem
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.13.6

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 jesse@pollak.io. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in instant2fa.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,42 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jesse Pollak
+
+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,54 @@
+# Instant2FA
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/instant2fa`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'instant2fa'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install instant2fa
+
+## Usage
+
+```ruby
+Instant2FA.configure do |config|
+  config.access_key = 'YOUR_ACCESS_KEY'
+  config.access_secret = 'YOUR_ACCESS_SECRET'
+end
+
+distinct_id = "A_UNIQUE_ID_FOR_A_USER"
+
+hosted_page_url = Instant2FA.create_settings(distinct_id)
+hosted_page_url = Instant2FA.create_verification(distinct_id)
+verification_succeeded = Instant2FA.confirm_verification(distinct_id, token)
+```
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/instant2fa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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 "instant2fa"
+
+# 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

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/instant2fa.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'instant2fa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "instant2fa"
+  spec.version       = Instant2FA::VERSION
+  spec.authors       = ["Jesse Pollak"]
+  spec.email         = ["jesse@instant2fa.com"]
+
+  spec.summary       = %q{A library for using the Instant 2FA API.}
+  spec.homepage      = "https://instant2fa.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec", "~> 4", ">= 4.7.3"
+  spec.add_development_dependency "pry", "~> 0.10", ">= 0.10.4"
+
+  spec.add_dependency "json_api_client", ">= 1.3.0", "<2.0.0"
+  spec.add_dependency 'activesupport', ">= 4.0.0", "<5.0.0"
+end

data/lib/instant2fa/client.rb

@@ -0,0 +1,72 @@
+require 'base64'
+require 'json'
+
+require 'instant2fa/resources'
+require 'instant2fa/errors'
+require 'instant2fa/middleware/unprocessable_entity_status'
+
+module Instant2FA
+  class Client
+
+    attr_accessor :config
+
+    def initialize(config=Instant2FA.config.dup, options={})
+      @config = config
+
+      Resources::Base.site = @config.api_base
+      Resources::Base.connection(true) do |connection|
+        # hack because it currently doesn't raise for 422
+        connection.use Middleware::UnprocessableEntityStatus
+        connection.use FaradayMiddleware::FollowRedirects
+        connection.use Faraday::Request::BasicAuthentication, @config.access_key, @config.access_secret
+      end
+    end
+
+    def create_settings(distinct_id, options = {})
+      user_access_token = Resources::UserAccessToken.create(distinct_id: distinct_id)
+      raise_if_errors(user_access_token)
+      return user_access_token.hosted_page_url
+    end
+
+    def create_verification(distinct_id, options = {})
+      begin
+        verification_request = Resources::VerificationRequest.create(distinct_id: distinct_id)
+        raise_if_errors(verification_request)
+      rescue JsonApiClient::Errors::UnprocessableEntity
+        raise Errors::MFANotEnabled.new, "User has not enabled an MFA device on their account."
+      end
+
+      return verification_request.hosted_page_url
+    end
+
+    def confirm_verification(distinct_id, token, options = {})
+      verification_response_result_set = Resources::VerificationResponseToken.find(token)
+      verification_response = verification_response_result_set[0]
+
+      if verification_response.distinct_id != distinct_id
+        raise Errors::VerificationMismatch, "The distinctID passed back from the request didn't match the one passed into this function. Are you passing in the right value for distinctID?"
+      end
+
+      if verification_response.status != 'succeeded'
+        raise Errors::VerificationFailed, "The verification did not pass. The status was: #{verification_response.status}."
+      end
+
+      true
+    end
+
+    protected
+
+    def raise_if_errors(resource)
+      unless resource.errors.empty?
+        raise Errors::ValidationError, "#{resource.class} could not be created due to a validation error."
+      end
+    end
+
+    def symoblize_keys(hash)
+      hash.inject({}) do |memo, (k, v)|
+        memo[k.to_sym] = v.is_a?(Hash) ? symoblize_keys(v) : v
+        memo
+      end
+    end
+  end
+end

data/lib/instant2fa/configuration.rb

@@ -0,0 +1,18 @@
+require "instant2fa/resources"
+
+module Instant2FA
+  class Configuration
+    attr_accessor :access_key
+    attr_accessor :access_secret
+    attr_accessor :api_base
+    attr_accessor :debug
+
+    def initialize
+      @api_base = 'https://api.instant2fa.com/'
+    end
+
+    def debug?
+      @debug
+    end
+  end
+end

data/lib/instant2fa/errors.rb

@@ -0,0 +1,18 @@
+module Instant2FA
+  module Errors
+    class Instant2FAError < StandardError
+    end
+
+    class MFANotEnabled < Instant2FAError
+    end
+
+    class ValidationError < Instant2FAError
+    end
+
+    class VerificationMismatch < Instant2FAError
+    end
+
+    class VerificationFailed < Instant2FAError
+    end
+  end
+end

data/lib/instant2fa/middleware/unprocessable_entity_status.rb

@@ -0,0 +1,37 @@
+module JsonApiClient::Errors
+  unless defined? UnprocessableEntity
+    class UnprocessableEntity < ServerError
+      def message
+        "Unable to process request"
+      end
+    end
+  end
+end
+
+module Instant2FA
+  module Middleware
+    class UnprocessableEntityStatus < Faraday::Middleware
+      def call(environment)
+        @app.call(environment).on_complete do |env|
+          handle_status(env[:status], env)
+
+          # look for meta[:status]
+          if env[:body].is_a?(Hash)
+            code = env[:body].fetch("meta", {}).fetch("status", 200).to_i
+            handle_status(code, env)
+          end
+        end
+      rescue Faraday::ConnectionFailed, Faraday::TimeoutError
+        raise Errors::ConnectionError, environment
+      end
+
+      protected
+
+      def handle_status(code, env)
+        if code == 422
+          raise JsonApiClient::Errors::UnprocessableEntity, env
+        end
+      end
+    end
+  end
+end

data/lib/instant2fa/resources.rb

@@ -0,0 +1,46 @@
+require 'json_api_client'
+
+module Instant2FA
+  class ConnectionConfiguration
+  end
+
+  module Resources
+    class UnprocessableEntity < JsonApiClient::Errors::ServerError
+      def message
+        "Unable to process request"
+      end
+    end
+
+    class Base < JsonApiClient::Resource
+      property :distinct_id, type: :string
+
+      def self.site=(url)
+        super(url)
+        self.connection(rebuild: true)
+      end
+
+      def self.path(params)
+        previous = super(params)
+        previous + "/"
+      end
+
+      self.site = 'https://api.instant2fa.com/'
+      self.route_format = :dasherized_key
+    end
+
+    class UserAccessToken < Base
+      property :hosted_page_url, type: :string
+    end
+
+    class VerificationRequest < Base
+      property :hosted_page_url, type: :string
+    end
+
+    class VerificationResponseToken < Base
+    end
+
+    class VerificationResponse < Base
+      property :status, type: :string
+    end
+  end
+end

data/lib/instant2fa/version.rb

@@ -0,0 +1,3 @@
+module Instant2FA
+  VERSION = "0.0.1"
+end

data/lib/instant2fa.rb

@@ -0,0 +1,29 @@
+require "active_support"
+require "active_support/core_ext"
+
+require "instant2fa/version"
+require "instant2fa/configuration"
+require "instant2fa/client"
+
+module Instant2FA
+  extend self
+
+  def configure
+    yield(config)
+  end
+
+  def config
+    @config ||= Configuration.new
+  end
+
+  def new(config=Instant2FA.config.dup, options={})
+    Client.new(config, options)
+  end
+
+  def client
+    @client ||= new(config)
+  end
+
+  delegate(*Configuration.public_instance_methods(false), to: :config)
+  delegate(*Client.public_instance_methods(false) - [:config], to: :client)
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: instant2fa
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jesse Pollak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: json_api_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: 
+email:
+- jesse@instant2fa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- instant2fa.gemspec
+- lib/instant2fa.rb
+- lib/instant2fa/client.rb
+- lib/instant2fa/configuration.rb
+- lib/instant2fa/errors.rb
+- lib/instant2fa/middleware/unprocessable_entity_status.rb
+- lib/instant2fa/resources.rb
+- lib/instant2fa/version.rb
+homepage: https://instant2fa.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A library for using the Instant 2FA API.
+test_files: []