stytch 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f31f4c1727653f8dbdd402bb9e97d31ed7893f537c7f98923b3abfa6d1bbcc14
-  data.tar.gz: a3cdadaa143fcfc4e0d72b1d0f0e35246a254ff8482c56627fa6d7cb6cb2e898
+  metadata.gz: c1f99d2093072e2e5ee91b23fa745105f56a4ae2b8abcd4ce01f76048d9bec42
+  data.tar.gz: 718a09bc69310b8e30627ebe66cdddb49713f9101dd06cfe13746c8ad88a0ff3
 SHA512:
-  metadata.gz: 56aec4b2699da311092641a43150259a8315ff6c53a460377910dddebffb8c5f02986481a8ef9b8851bb40e25dfb46805b058055bef59b68d6a1d1b688c438fc
-  data.tar.gz: 07c8003263f90593c7c9e86920b8d866621e2890fb477e4d3b05eeb80c56b23c2cfab5913db80b76fe0b4be8d6260e26ce877f2000e8e3686515fce6a5867e5b
+  metadata.gz: a90634d8f228fd2860f3674dc7fd522d0d14cf0c36928bc547cafcba1e428597de622e503d1e1758df2fe90e62d0ca6e6fcdb8ff73232b6ce73cdd7b77565591
+  data.tar.gz: 48117adc597da070fdd886e3bb30e9a27820913933dfe3636b1222a698ad135837debee40c4d71d04d984075a1d324659e25e9e5b7368452add397698027e60a

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in stytch.gemspec
-gemspec
+gemspec

data/README.md

@@ -32,7 +32,7 @@ client = Stytch::Client.new(
 
 Then make desired API call.
 ```
-client.get_user(user_id: user_id)
+client.users.get(user_id: user_id)
 ```
 
 ## License

data/Rakefile

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

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "stytch"
+require 'bundler/setup'
+require 'stytch'
 
 # 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.
@@ -10,5 +11,5 @@ require "stytch"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/stytch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 

data/lib/stytch/client.rb

@@ -1,30 +1,35 @@
-require_relative 'endpoints/user'
-require_relative 'endpoints/magic'
-require_relative 'endpoints/otp'
+# frozen_string_literal: true
+
+require_relative 'users'
+require_relative 'magic_links'
+require_relative 'otps'
 
 module Stytch
   class Client
-    include Stytch::Endpoints::User
-    include Stytch::Endpoints::Magic
-    include Stytch::Endpoints::OTP
-
     ENVIRONMENTS = %i[live test].freeze
 
+    attr_reader :users, :magic_links, :otps
+
     def initialize(env:, project_id:, secret:, &block)
       @api_host   = api_host(env)
-      @project_id  = project_id
+      @project_id = project_id
       @secret     = secret
 
       create_connection(&block)
+
+      @users = Stytch::Users.new(@connection)
+      @magic_links = Stytch::MagicLinks.new(@connection)
+      @otps = Stytch::OTPs.new(@connection)
     end
 
     private
 
     def api_host(env)
-      if env == :live
-        "https://api.stytch.com"
-      elsif env == :test
-        "https://test.stytch.com"
+      case env
+      when :live
+        'https://api.stytch.com'
+      when :test
+        'https://test.stytch.com'
       else
         raise ArgumentError, "Invalid value for env (#{@env}): should be live or test"
       end
@@ -45,43 +50,5 @@ module Stytch
       builder.response :json, content_type: /\bjson$/
       builder.adapter Faraday.default_adapter
     end
-
-    def get(path)
-      @connection.get(
-          path
-      ).body
-    end
-
-    def post(path, payload)
-      @connection.post(
-          path,
-          payload
-      ).body
-    end
-
-    def put(path, payload)
-      @connection.put(
-          path,
-          payload
-      ).body
-    end
-
-    def delete(path)
-      @connection.delete(
-          path
-      ).body
-    end
-
-    def request_with_query_params(path, params)
-      request = path
-      params.compact.each_with_index do |p, i|
-        if i == 0
-          request += "?#{p[0].to_s}=#{p[1]}"
-        else
-          request += "&#{p[0].to_s}=#{p[1]}"
-        end
-      end
-      request
-    end
   end
 end

data/lib/stytch/{endpoints/magic.rb → magic_links.rb}

@@ -1,9 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'request_helper'
+
 module Stytch
-  module Endpoints
-    module Magic
-      PATH = "/v1/magic_links".freeze
+  class MagicLinks
+    include Stytch::RequestHelper
+
+    attr_reader :email
+
+    PATH = '/v1/magic_links'
+
+    def initialize(connection)
+      @connection = connection
+
+      @email = Stytch::MagicLinks::Email.new(@connection)
+    end
 
-      def send_magic_by_email(
+    def authenticate(
+      token:,
+      attributes: {},
+      options: {}
+    )
+      request = {
+        token: token
+      }
+
+      request[:attributes] = attributes if attributes != {}
+      request[:options] = options if options != {}
+
+      post_request("#{PATH}/authenticate", request)
+    end
+
+    class Email
+      include Stytch::RequestHelper
+
+      PATH = "#{Stytch::MagicLinks::PATH}/email"
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def send(
         email:,
         login_magic_link_url:,
         signup_magic_link_url:,
@@ -14,17 +51,17 @@ module Stytch
         request = {
           email: email,
           login_magic_link_url: login_magic_link_url,
-          signup_magic_link_url: signup_magic_link_url,
+          signup_magic_link_url: signup_magic_link_url
         }
 
-        request[:login_expiration_minutes] = login_expiration_minutes if login_expiration_minutes != nil
-        request[:signup_expiration_minutes] = signup_expiration_minutes if signup_expiration_minutes != nil
+        request[:login_expiration_minutes] = login_expiration_minutes unless login_expiration_minutes.nil?
+        request[:signup_expiration_minutes] = signup_expiration_minutes unless signup_expiration_minutes.nil?
         request[:attributes] = attributes if attributes != {}
 
-        post("#{PATH}/send_by_email", request)
+        post_request("#{PATH}/send", request)
       end
 
-      def login_or_create_user(
+      def login_or_create(
         email:,
         login_magic_link_url:,
         signup_magic_link_url:,
@@ -33,63 +70,47 @@ module Stytch
         attributes: {},
         create_user_as_pending: false
       )
-
         request = {
           email: email,
           login_magic_link_url: login_magic_link_url,
           signup_magic_link_url: signup_magic_link_url,
-          create_user_as_pending: create_user_as_pending,
+          create_user_as_pending: create_user_as_pending
         }
 
-        request[:login_expiration_minutes] = login_expiration_minutes if login_expiration_minutes != nil
-        request[:signup_expiration_minutes] = signup_expiration_minutes if signup_expiration_minutes != nil
+        request[:login_expiration_minutes] = login_expiration_minutes unless login_expiration_minutes.nil?
+        request[:signup_expiration_minutes] = signup_expiration_minutes unless signup_expiration_minutes.nil?
         request[:attributes] = attributes if attributes != {}
 
-        post("#{PATH}/login_or_create", request)
+        post_request("#{PATH}/login_or_create", request)
       end
 
-      def invite_by_email(
+      def invite(
         email:,
         invite_magic_link_url:,
         invite_expiration_minutes: nil,
         attributes: {},
         name: {}
       )
-
         request = {
           email: email,
-          invite_magic_link_url: invite_magic_link_url,
+          invite_magic_link_url: invite_magic_link_url
         }
 
-        request[:invite_expiration_minutes] = invite_expiration_minutes if invite_expiration_minutes != nil
+        request[:invite_expiration_minutes] = invite_expiration_minutes unless invite_expiration_minutes.nil?
         request[:attributes] = attributes if attributes != {}
         request[:name] = name if name != {}
 
-        post("#{PATH}/invite_by_email", request)
+        post_request("#{PATH}/invite", request)
       end
 
-      def revoke_invite_by_email(
+      def revoke_invite(
         email:
       )
-
         request = {
-          email: email,
+          email: email
         }
 
-        post("#{PATH}/revoke_invite", request)
-      end
-
-      def authenticate_magic(
-        token:,
-        attributes: {},
-        options: {}
-      )
-        request = {}
-
-        request[:attributes] = attributes if attributes != {}
-        request[:options] = options if options != {}
-
-        post("#{PATH}/#{token}/authenticate", request)
+        post_request("#{PATH}/revoke_invite", request)
       end
     end
   end

data/lib/stytch/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'net/http'
 require 'uri'
@@ -7,8 +9,8 @@ require_relative 'version'
 module Stytch
   class Middleware < ::Faraday::Response::Middleware
     NETWORK_HEADERS = {
-      'User-Agent'    => "Stytch Ruby v#{Stytch::VERSION}",
-      'Content-Type'  => 'application/json',
+      'User-Agent' => "Stytch Ruby v#{Stytch::VERSION}",
+      'Content-Type' => 'application/json'
     }.freeze
 
     NETWORK_TIMEOUT = 300

data/lib/stytch/otps.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require_relative 'request_helper'
+
+module Stytch
+  class OTPs
+    include Stytch::RequestHelper
+
+    attr_reader :sms
+
+    PATH = '/v1/otps'
+
+    def initialize(connection)
+      @connection = connection
+
+      @sms = Stytch::OTPs::SMS.new(@connection)
+    end
+
+    def authenticate(
+      method_id:,
+      code:,
+      attributes: {},
+      options: {}
+    )
+      request = {
+        method_id: method_id,
+        code: code
+      }
+
+      request[:attributes] = attributes if attributes != {}
+      request[:options] = options if options != {}
+
+      post_request("#{PATH}/authenticate", request)
+    end
+
+    class SMS
+      include Stytch::RequestHelper
+
+      PATH = "#{Stytch::OTPs::PATH}/sms"
+
+      def initialize(connection)
+        @connection = connection
+      end
+
+      def send(
+        phone_number:,
+        expiration_minutes: nil,
+        attributes: {}
+      )
+        request = {
+          phone_number: phone_number,
+          expiration_minutes: expiration_minutes
+        }
+
+        request[:attributes] = attributes if attributes != {}
+
+        post_request("#{PATH}/send", request)
+      end
+
+      def login_or_create(
+        phone_number:,
+        expiration_minutes: nil,
+        attributes: {},
+        create_user_as_pending: false
+      )
+        request = {
+          phone_number: phone_number,
+          expiration_minutes: expiration_minutes,
+          create_user_as_pending: create_user_as_pending
+        }
+
+        request[:attributes] = attributes if attributes != {}
+
+        post_request("#{PATH}/login_or_create", request)
+      end
+    end
+  end
+end

data/lib/stytch/request_helper.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Stytch
+  module RequestHelper
+    def get_request(path)
+      @connection.get(
+        path
+      ).body
+    end
+
+    def post_request(path, payload)
+      @connection.post(
+        path,
+        payload
+      ).body
+    end
+
+    def put_request(path, payload)
+      @connection.put(
+        path,
+        payload
+      ).body
+    end
+
+    def delete_request(path)
+      @connection.delete(
+        path
+      ).body
+    end
+
+    def request_with_query_params(path, params)
+      request = path
+      params.compact.each_with_index do |p, i|
+        request += if i.zero?
+                     "?#{p[0]}=#{p[1]}"
+                   else
+                     "&#{p[0]}=#{p[1]}"
+                   end
+      end
+      request
+    end
+  end
+end

data/lib/stytch/users.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require_relative 'request_helper'
+
+module Stytch
+  class Users
+    include Stytch::RequestHelper
+
+    PATH = '/v1/users'
+
+    def initialize(connection)
+      @connection = connection
+    end
+
+    def get(user_id:)
+      get_request("#{PATH}/#{user_id}")
+    end
+
+    def get_pending(
+      limit: nil,
+      starting_after_id: nil
+    )
+      query_params = {
+        limit: limit,
+        starting_after_id: starting_after_id
+      }
+
+      request = request_with_query_params("#{PATH}/pending", query_params)
+
+      get_request(request)
+    end
+
+    def create(
+      email: nil,
+      phone_number: nil,
+      name: {},
+      create_user_as_pending: false,
+      attributes: {}
+    )
+      request = {
+        email: email,
+        phone_number: phone_number,
+        create_user_as_pending: create_user_as_pending
+      }
+
+      request[:name] = name if name != {}
+      request[:attributes] = attributes if attributes != {}
+
+      post_request(PATH, request)
+    end
+
+    def update(
+      user_id:,
+      name: {},
+      emails: [],
+      phone_numbers: [],
+      attributes: {}
+    )
+      request = {
+        emails: format_emails(emails),
+        phone_numbers: format_phone_numbers(phone_numbers)
+      }
+
+      request[:name] = name if name != {}
+      request[:attributes] = attributes if attributes != {}
+
+      put_request("#{PATH}/#{user_id}", request)
+    end
+
+    def delete(user_id:)
+      delete_request("#{PATH}/#{user_id}")
+    end
+
+    def delete_email(
+      email_id:
+    )
+      delete_request("#{PATH}/emails/#{email_id}")
+    end
+
+    def delete_phone_number(
+      phone_id:
+    )
+      delete_request("#{PATH}/phone_numbers/#{phone_id}")
+    end
+
+    private
+
+    def format_emails(emails)
+      e = []
+      emails.each { |email| e << { email: email } }
+      e
+    end
+
+    def format_phone_numbers(phone_numbers)
+      p = []
+      phone_numbers.each { |phone_number| p << { phone_number: phone_number } }
+      p
+    end
+  end
+end

data/lib/stytch/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Stytch
-  VERSION = "1.0.0"
+  VERSION = '2.0.0'
 end

data/stytch.gemspec

@@ -1,27 +1,29 @@
+# frozen_string_literal: true
+
 require_relative 'lib/stytch/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "stytch"
+  spec.name          = 'stytch'
   spec.version       = Stytch::VERSION
-  spec.authors       = ["alex-stytch"]
-  spec.email         = ["alex@stytch.com"]
+  spec.authors       = ['stytch']
+  spec.email         = ['support@stytch.com']
 
-  spec.summary       = "Stytch Ruby Gem"
-  spec.homepage      = "https://stytch.com"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Stytch Ruby Gem'
+  spec.homepage      = 'https://stytch.com'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/stytchauth/stytch-ruby"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/stytchauth/stytch-ruby'
 
   # 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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_dependency 'faraday', '>= 0.17.0', '< 2.0'
   spec.add_dependency 'faraday_middleware', '>= 0.14.0', '< 2.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stytch
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
-- alex-stytch
+- stytch
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-01 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,7 +52,7 @@ dependencies:
         version: '2.0'
 description:
 email:
-- alex@stytch.com
+- support@stytch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -69,10 +69,11 @@ files:
 - bin/setup
 - lib/stytch.rb
 - lib/stytch/client.rb
-- lib/stytch/endpoints/magic.rb
-- lib/stytch/endpoints/otp.rb
-- lib/stytch/endpoints/user.rb
+- lib/stytch/magic_links.rb
 - lib/stytch/middleware.rb
+- lib/stytch/otps.rb
+- lib/stytch/request_helper.rb
+- lib/stytch/users.rb
 - lib/stytch/version.rb
 - stytch.gemspec
 homepage: https://stytch.com

data/lib/stytch/endpoints/otp.rb

@@ -1,56 +0,0 @@
-module Stytch
-  module Endpoints
-    module OTP
-      PATH = "/v1/otp".freeze
-
-      def send_otp_by_sms(
-        phone_number:,
-        expiration_minutes: nil,
-        attributes: {}
-      )
-        request = {
-          phone_number: phone_number,
-          expiration_minutes: expiration_minutes,
-        }
-
-        request[:attributes] = attributes if attributes != {}
-
-        post("#{PATH}/send_by_sms", request)
-      end
-
-      def login_or_create_user_by_sms(
-        phone_number:,
-        expiration_minutes: nil,
-        attributes: {},
-        create_user_as_pending: false
-      )
-        request = {
-          phone_number: phone_number,
-          expiration_minutes: expiration_minutes,
-          create_user_as_pending: create_user_as_pending
-        }
-
-        request[:attributes] = attributes if attributes != {}
-
-        post("#{PATH}/login_or_create", request)
-      end
-
-      def authenticate_otp(
-        method_id:,
-        code:,
-        attributes: {},
-        options: {}
-      )
-        request = {
-          method_id: method_id,
-          code: code,
-        }
-
-        request[:attributes] = attributes if attributes != {}
-        request[:options] = options if options != {}
-
-        post("#{PATH}/authenticate", request)
-      end
-    end
-  end
-end

data/lib/stytch/endpoints/user.rb

@@ -1,92 +0,0 @@
-module Stytch
-  module Endpoints
-    module User
-      PATH = "/v1/users".freeze
-
-      def get_user(user_id:)
-        get("#{PATH}/#{user_id}")
-      end
-
-      def get_pending_users(
-        limit: nil,
-        starting_after_id: nil
-      )
-        query_params = {
-            limit: limit,
-            starting_after_id: starting_after_id,
-        }
-
-        request = request_with_query_params("#{PATH}/pending", query_params)
-
-        get(request)
-      end
-
-      def create_user(
-        email: nil,
-        phone_number: nil,
-        name: {},
-        create_user_as_pending: false,
-        attributes: {}
-      )
-        request = {
-          email: email,
-          phone_number: phone_number,
-          create_user_as_pending: create_user_as_pending
-        }
-
-        request[:name] = name if name != {}
-        request[:attributes] = attributes if attributes != {}
-
-        post(PATH, request)
-      end
-
-      def update_user(
-        user_id:,
-        name: {},
-        emails: [],
-        phone_numbers: [],
-        attributes: {}
-      )
-        request = {
-          emails: format_emails(emails),
-          phone_numbers: format_phone_numbers(phone_numbers),
-        }
-
-        request[:name] = name if name != {}
-        request[:attributes] = attributes if attributes != {}
-
-        put("#{PATH}/#{user_id}", request)
-      end
-
-      def delete_user(user_id:)
-        delete("#{PATH}/#{user_id}")
-      end
-
-      def delete_user_email(
-        email_id:
-      )
-        delete("#{PATH}/emails/#{email_id}")
-      end
-
-      def delete_user_phone_number(
-        phone_id:
-      )
-        delete("#{PATH}/phone_numbers/#{phone_id}")
-      end
-
-      private
-
-      def format_emails(emails)
-        e = []
-        emails.each { |email| e << { email: email} }
-        e
-      end
-
-      def format_phone_numbers(phone_numbers)
-        p = []
-        phone_numbers.each { |phone_number| p << { phone_number: phone_number} }
-        p
-      end
-    end
-  end
-end