streambird 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc7c798a9d73a5e3c7d2c76bfb2c06a49ed96a5c57999c3a1d15769024b5457d
+  data.tar.gz: 8ba83f95ae432d0be726b67c19629dd04505f7714ceb64f19439ff097f9f4855
+SHA512:
+  metadata.gz: f2c7f1865c6093960cada4050eb708fffbd73c07e74979df6f1911a692737f62fbb9f8e6d88f8fd8f847896d563989d351ee9d6a74a2adeddd981cbbd0fbd13f
+  data.tar.gz: bfc73850bd1d4eccba28a21c1039d143d28ce78621aab02964a8019d1519d75a6cdec0d07fdaa761ba75141eeb5e9a9b881a9bf0350b5d90c63e219010dc79cb

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.0
+  - 2.5.0
+notifications:
+  email: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Streambird, Inc.
+
+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,61 @@
+# Streambird
+
+This is the official Streambird RubyGem (`streambird`).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'streambird'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install streambird
+
+## Usage
+
+First, initialize the Streambird client:
+
+```ruby
+require 'streambird'
+
+streambird = Streambird.new(api_key: 'API_KEY')
+```
+
+## Errors
+
+This gem will raise exceptions on application-level errors. Here are the list of errors:
+
+```ruby
+Streambird::Api::BadRequest
+Streambird::Api::TooManyRequests
+Streambird::Api::NotFound
+Streambird::Api::Unauthorized
+Streambird::Api::InternalServerError
+Streambird::Api::ConnectionError
+Streambird::Api::APIKeyInvalid
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 `streambird-ruby.gemspec`, 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).
+
+To test locally, run `bundle exec rspec`. By default, client - server communication is mocked by [vcr](https://github.com/vcr/vcr), which uses local [casettes](spec/cassettes) recorded from production server.
+To test against production server, set a test api key as `STREAMBIRD_TEST_API_KEY` and run `bundle exec rake spec:production`, which sets environment variable `STREAMBIRD_TEST_SERVER` to `production`. It will also update new client - server communication in the cassette.
+Please note that changes in the cassettes will break existing specs. This is because 1) the server may return random results for test api key, and 2) some of the cassettes have been modified specifically for the specs.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/streambird/streambird-ruby.
+
+## 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,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+import './tasks/spec_production.rake'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "streambird"
+
+# 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/lib/streambird/api/errors.rb

@@ -0,0 +1,46 @@
+class Streambird
+  class Api
+    class Error < StandardError
+      attr_accessor :status_code
+
+      def initialize(message = 'Please double check the request was properly formed and try again', status_code = 400)
+        super(message)
+        self.status_code = status_code
+      end
+    end
+
+    class BadRequest < Error
+    end
+
+    class TooManyRequests < Error
+    end
+
+    class NotFound < Error
+    end
+
+    class Unauthorized < Error
+      def initialize(message = "Please ensure that the api_key provided is correct. To find your API key, go to your Streambird Dashboard", status_code = 401)
+        super(message, status_code)
+      end
+    end
+
+    class InternalServerError < Error
+      def initialize(message = "Streambird's servers are currently experiencing issues. Please wait a moment and try again.", status_code = 500)
+        super(message, status_code)
+      end
+    end
+
+    class ConnectionError < Error
+      def initialize(message = "There's an issue connecting to Streambird's servers. Please check you're connected to the internet, and try again.'", status_code = nil)
+        super(message, status_code)
+      end
+    end
+
+    class APIKeyInvalid < Error
+      def initialize(message = "Provided api_key is invalid. Please double check you passed it in correctly and try again. If you're having trouble finding it, check your Streambird Dashboard", status_code = nil)
+        super(message, status_code)
+      end
+    end
+
+  end
+end

data/lib/streambird/api/magic_links.rb

@@ -0,0 +1,47 @@
+class Streambird
+  class Api
+    class MagicLinks < Struct.new(:client)
+      
+      def email
+        @email ||= Streambird::Api::MagicLinks::Email.new(client)
+      end
+
+      def create(user_id:)
+        req = {
+          'user_id': user_id,
+        }
+        response = client.post('auth/magic_links/create', req)
+        json_body = JSON.parse(response.body, symbolize_names: true)
+        return json_body
+      end
+
+      class Email < Struct.new(:client)
+
+        def login_or_create(email:,
+          login_redirect_url: nil,
+          registration_redirect_url: nil,
+          login_expires_in: nil,
+          registration_expires_in: nil,
+          requires_verification: nil,
+          device_fingerprint: {}
+        )
+
+          req = {
+            'email': email,
+          }
+
+          req['login_redirect_url'] = login_redirect_url if !login_redirect_url.nil?
+          req['registration_redirect_url'] = registration_redirect_url if !registration_redirect_url.nil?
+          req['registration_expires_in'] = registration_expires_in if !registration_expires_in.nil?
+          req['login_expires_in'] = login_expires_in if !login_expires_in.nil?
+          req['requires_verification'] = requires_verification if !requires_verification.nil?
+          req['device_fingerprint'] = device_fingerprint if device_fingerprint != {}
+          response = client.post('auth/magic_links/email/login_or_create', req)
+
+          json_body = JSON.parse(response.body, symbolize_names: true)
+          return json_body
+        end
+      end
+    end
+  end
+end

data/lib/streambird/api.rb

@@ -0,0 +1,77 @@
+require 'uri'
+require 'faraday'
+require 'json'
+
+class Streambird
+  class Api < Struct.new(:api_key, :default_request_params, :logging)
+    STREAMBIRD_API_URL = 'http://localhost:11019/v1/'
+    STREAMBIRD_GEM_INFO = Gem.loaded_specs["streambird"]
+    STREAMBIRD_RUBY_CLIENT_VERSION = STREAMBIRD_GEM_INFO ? STREAMBIRD_GEM_INFO.version.to_s : '0.1.1'.freeze
+
+    def connection
+      @connection ||= Faraday.new(:url => STREAMBIRD_API_URL) do |faraday|
+        faraday.request :authorization, 'Bearer', self.api_key
+        faraday.request  :url_encoded             # form-encode POST params
+        faraday.response :logger if logging       # log requests to STDOUT
+        faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+      end
+    end
+
+    def get(url, params = {})
+      response = connection.get do |req|
+        req.url "#{STREAMBIRD_API_URL}#{url}"
+        req.params.merge!(default_request_params.merge(params))
+        req.headers['X-API-Client'] = "Ruby"
+        req.headers["X-API-Client-Version"] = STREAMBIRD_RUBY_CLIENT_VERSION
+      end
+
+      if response.status != 200
+        return handle_error(response)
+      end
+
+      response
+    rescue Faraday::Error::ConnectionFailed
+      raise Streambird::Api::ConnectionError
+    end
+
+    def post(url, body = {})
+      
+      body = default_request_params.merge(body)
+      response = connection.post do |req|
+        req.url "#{STREAMBIRD_API_URL}#{url}"
+        req.headers['Content-Type'] = 'application/json'
+        req.body = body.to_json
+        req.headers['X-API-Client'] = "Ruby"
+        req.headers["X-API-Client-Version"] = STREAMBIRD_RUBY_CLIENT_VERSION
+      end
+
+      if response.status != 200 and response.status != 201
+        return handle_error(response)
+      end
+
+      response
+    rescue Faraday::Error::ConnectionFailed
+      raise Streambird::Api::ConnectionError
+    end
+
+    def handle_error(response)
+      error_body = JSON.parse(response.body)
+      if response.status == 404
+        raise Streambird::Api::NotFound.new(error_body['error_message'], response.status)
+      elsif response.status == 429
+        raise Streambird::Api::TooManyRequests.new(error_body['error_message'], response.status)
+      elsif response.status > 499
+        raise Streambird::Api::InternalServerError.new(error_body['error_message'], response.status)
+      elsif response.status == 401
+        raise Streambird::Api::Unauthorized.new(error_body['error_message'], response.status)
+      else
+        raise Streambird::Api::BadRequest.new(error_body['error_message'], response.status)
+      end
+    rescue JSON::ParserError
+      raise Streambird::Api::InternalServerError
+    end
+  end
+end
+
+require 'streambird/api/errors'
+

data/lib/streambird.rb

@@ -0,0 +1,43 @@
+class Streambird
+  attr_accessor :api_key, :default_request_params, :logging
+
+  def self.validate_api_key(api_key)
+    if api_key.length < 5 || !(api_key.start_with?('sk_live') || api_key.start_with?('sk_test')) 
+      raise Api::APIKeyInvalid
+    end
+  end
+
+  def initialize(api_key: nil, default_request_params: {}, logging: false)
+    Streambird.validate_api_key(api_key)
+
+    self.api_key = api_key
+    self.default_request_params = default_request_params
+    self.logging = logging
+  end
+
+  def live?
+    api_key.start_with?('sk_live')
+  end
+
+  def test?
+    api_key.start_with?('sk_test')
+  end
+
+  def client
+    puts default_request_params
+    @client ||= Api.new(api_key, default_request_params, logging)
+  end
+
+  def magic_links
+    @magic_links ||= Streambird::Api::MagicLinks.new(client)
+  end
+
+  alias_method :live, :live?
+  alias_method :test, :test?
+  alias_method :live_mode?, :live?
+  alias_method :test_mode?, :test?
+end
+
+require 'streambird/api'
+require 'streambird/api/errors'
+require 'streambird/api/magic_links'

data/streambird-ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "streambird"
+  spec.version       = "1.0.1"
+  spec.authors       = ["streambird"]
+  spec.email         = ["hello@streambird.io"]
+
+  spec.summary       = %q{Official Ruby Client for Streambird API}
+  spec.description   = %q{Streambird is an API For passwordless authentication for web2 and web3. Onboarding users within minutes. This is the official Ruby client.}
+  spec.homepage      = "https://streambird.io"
+  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.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "webmock", "~> 3.5"
+  spec.add_development_dependency "vcr", "~> 4.0"
+
+  spec.add_dependency "faraday", "~> 0.11.0"
+end

data/tasks/spec_production.rake

@@ -0,0 +1,10 @@
+namespace :spec do
+  desc 'Run rspec against production server instead of local cassettes'
+  task :production do
+    if ENV['STREAMBIRD_TEST_API_KEY'].nil?
+      raise 'Please specify STREAMBIRD_TEST_API_KEY to run against production server'
+    end
+    ENV['STREAMBIRD_TEST_SERVER'] = 'production'
+    Rake::Task['spec'].invoke
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: streambird
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- streambird
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: Streambird is an API For passwordless authentication for web2 and web3.
+  Onboarding users within minutes. This is the official Ruby client.
+email:
+- hello@streambird.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/streambird.rb
+- lib/streambird/api.rb
+- lib/streambird/api/errors.rb
+- lib/streambird/api/magic_links.rb
+- streambird-ruby.gemspec
+- tasks/spec_production.rake
+homepage: https://streambird.io
+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.7.6.2
+signing_key:
+specification_version: 4
+summary: Official Ruby Client for Streambird API
+test_files: []