verifykit 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78c1a3ee627f8960c242b2d27797b565a16bd0f84d860fb0ab7d01667e83d3ef
-  data.tar.gz: e80c212d8fb2e387b767aebb22b3f86668e840eadd79b45de9b5077a7fa5a323
+  metadata.gz: 2473e1046dcafaf0c25dd4bbab37d4b74a3e8f2b6464c8389b8c3b57697a69d7
+  data.tar.gz: e737bafa0ab02717d2f9f47af3230970877a2ca18a9d6c6b13c3af08e0b7e239
 SHA512:
-  metadata.gz: b479f90b3eb90bf629e39a88d8dec9d553d712f5ba1ea4a8acd73a062ea5396848261ca79ed7aa282f577f0dae57f4dc846d794cc338d00b86fa87af5cdb6c71
-  data.tar.gz: f92481d06803f355a68e8da2773a23d30a88bed00d5a5c032770788d136def72f512c8d669a16dd2411662cdf5d114e7722ecb0418e8b506e73e5c7e68146bfd
+  metadata.gz: edbd604aad4338fd0f48c6341118e6c24be073bd1821dd81c80b396b3f710a97734fc24aa0fa8512f2dbfb7bea8b5940bfc6bafae69493141faec551f82c277c
+  data.tar.gz: ac5b54578bdf04d4a84b77fa73ed33901cb32065b6266c1a5aabe21bd638f383b98590c77b901017c5a49b427deaf84040ea8d311f606c5e14d42e159b050cf5

data/Gemfile.lock

@@ -1,7 +1,14 @@
 PATH
   remote: .
   specs:
-    verifykit (0.0.0)
+    verifykit (0.1.0)
+      dry-configurable (~> 1.0, >= 1.0.1)
+      dry-initializer (~> 3.1, >= 3.1.1)
+      dry-monads (~> 1.6)
+      dry-struct (~> 1.6)
+      dry-types (~> 1.7, >= 1.7.1)
+      faraday (~> 2.7, >= 2.7.4)
+      zeitwerk (~> 2.6, >= 2.6.8)
 
 GEM
   remote: https://rubygems.org/
@@ -9,7 +16,40 @@ GEM
     ast (2.4.2)
     awesome_print (1.9.2)
     coderay (1.1.3)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
+    dry-configurable (1.0.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-initializer (3.1.1)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-monads (1.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-struct (1.6.0)
+      dry-core (~> 1.0, < 2)
+      dry-types (>= 1.7, < 2)
+      ice_nine (~> 0.11)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0)
+      dry-inflector (~> 1.0)
+      dry-logic (~> 1.4)
+      zeitwerk (~> 2.6)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    ice_nine (0.11.2)
     json (2.6.3)
     method_source (1.0.0)
     parallel (1.23.0)
@@ -48,7 +88,9 @@ GEM
     rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
     unicode-display_width (2.4.2)
+    zeitwerk (2.6.8)
 
 PLATFORMS
   arm64-darwin-22

data/README.md

@@ -32,7 +32,151 @@ gem install verifykit
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+```ruby
+# config/initializers/verifykit.rb
+
+VerifyKit.configure do |config|
+  # it's optional, you can set manually when you create a VerifyKit::Client instance too
+  config.server_key = ENV.fetch('VERIFYKIT_SERVER_KEY')
+
+  # it's optional, default is Logger.new(STDOUT)
+  config.logger = Rails.logger
+
+  # it's optional, default is false
+  config.debug.enabled = true
+
+  # it's optional, default is 'v1.0', you can set manually when you create a VerifyKit::Client instance too but VerifyKit doesn't support any other version yet, so don't change it
+  config.api_version = 'v1.0'
+end
+
+# or
+
+VerifyKit.config.server_key = ENV.fetch('VERIFYKIT_SERVER_KEY')
+VerifyKit.config.logger = Rails.logger
+VerifyKit.config.debug.enabled = true
+VerifyKit.config.api_version = 'v1.0'
+```
+
+### Client
+
+```ruby
+# you can create a client instance with default configuration
+client = VerifyKit::Client.new
+
+# or you can create a client instance with custom configuration
+client = VerifyKit::Client.new(server_key: 'your-server-key', api_version: 'v1.0')
+```
+
+### Verification
+
+VerifyKit supports two verification methods: `sms` and `whatsapp`.
+
+#### SMS Verification
+
+Send a verification code to the phone number like this:
+
+```ruby
+client = VerifyKit::Client.new
+
+params = { phoneNumber: '555 555 55 55', countryCode: 'TR' }
+query = { lang: 'tr' } # optional, default is 'en'
+
+result = client.sms.send(params) # or client.sms.send(params, query)
+
+if result.success?
+  success_response = result.success
+  # success_response is a VerifyKit::Response::Success instance
+
+  # do something
+else
+  error_response = result.failure
+  # error_response is a VerifyKit::Response::Error instance
+
+  # do something
+end
+```
+
+Check the verification code like this:
+
+```ruby
+client = VerifyKit::Client.new
+
+params = { phoneNumber: '554 597 46 46',
+           countryCode: 'TR',
+           reference: 'reference code',
+           code: 'verification code' }
+query = { lang: 'tr' } # optional, default is 'en'
+
+result = client.sms.check(params) # or client.sms.check(params, query)
+
+if result.success?
+  success_response = result.success
+  # success_response is a VerifyKit::Response::Success instance
+
+  # do something
+else
+  error_response = result.failure
+  # error_response is a VerifyKit::Response::Error instance
+
+  # do something
+end
+```
+
+#### WhatsApp Verification
+
+Send a verification code to the phone number like this:
+
+```ruby
+client = VerifyKit::Client.new
+
+params = { phoneNumber: '555 555 55 55', countryCode: 'TR' }
+query = { lang: 'tr' } # optional, default is 'en'
+
+result = client.whatsapp.send(params) # or client.whatsapp.send(params, query)
+
+if result.success?
+  success_response = result.success
+  # success_response is a VerifyKit::Response::Success instance
+
+  # do something
+else
+  error_response = result.failure
+  # error_response is a VerifyKit::Response::Error instance
+
+  # do something
+end
+```
+
+Check the verification code like this:
+
+```ruby
+client = VerifyKit::Client.new
+
+params = { reference: 'reference code',
+           code: 'verification code' }
+query = { lang: 'tr' } # optional, default is 'en'
+
+result = client.whatsapp.check(params) # or client.whatsapp.check(params, query)
+
+if result.success?
+  success_response = result.success
+  # success_response is a VerifyKit::Response::Success instance
+
+  # do something
+else
+  error_response = result.failure
+  # error_response is a VerifyKit::Response::Error instance
+
+  # do something
+end
+```
+
+### Response Objects
+
+- [VerifyKit::Response::Success](lib/verify_kit/responses/success.rb)
+- [VerifyKit::Response::Error](lib/verify_kit/responses/error.rb)
 
 ## Development
 

data/lib/verify_kit/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'faraday'
+
+module VerifyKit
+  class Client < Core::Service
+    BASE_URL = 'https://web-rest.verifykit.com'
+    SERVER_KEY_HEADER = 'X-Vfk-Server-Key'
+
+    option :server_key, type: Types::String | Types::Nil, default: proc { VerifyKit.config.server_key }
+    option :api_version, type: Types::String, default: proc { VerifyKit.config.api_version }
+    option :adapter, type: Types::Symbol, default: proc { Faraday.default_adapter }
+
+    def connection
+      @connection ||= Faraday.new(connection_url) do |conn|
+        conn.headers[SERVER_KEY_HEADER] = server_key
+        conn.request :json
+        conn.response :json, content_type: 'application/json'
+        conn.adapter adapter
+
+        if VerifyKit.config.debug.enabled
+          conn.response :logger, VerifyKit.config.logger, body: true,
+                                                          bodies: { request: true, response: true }
+        end
+      end
+    end
+
+    def sms
+      VerifyKit::Resources::SMS.new(self)
+    end
+
+    def whatsapp
+      VerifyKit::Resources::WhatsApp.new(self)
+    end
+
+    private
+
+    def connection_url
+      BASE_URL + "/#{api_version}"
+    end
+  end
+end

data/lib/verify_kit/core/service.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'dry-initializer'
+require 'dry/monads/all'
+
+module VerifyKit
+  module Core
+    class Service
+      extend Dry::Initializer
+
+      include Dry::Monads
+      include Dry::Monads::Do
+    end
+  end
+end

data/lib/verify_kit/resources/base.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module VerifyKit
+  module Resources
+    class Base < Core::Service
+      param :client, type: Types.Instance(VerifyKit::Client)
+      option :connection, type: Types.Instance(Faraday::Connection), default: proc { client.connection }
+
+      private
+
+      def get_request(url, params: {}, headers: {})
+        connection.get(url, params, headers)
+      end
+
+      def post_request(url, body:, headers: {}, params: {})
+        connection.post(url, body, headers) do |req|
+          req.params = params
+        end
+      end
+
+      def patch_request(url, body:, headers: {})
+        connection.patch(url, body, headers)
+      end
+
+      def put_request(url, body:, headers: {})
+        connection.put(url, body, headers)
+      end
+
+      def delete_request(url, params: {}, headers: {})
+        client.connection.delete(url, params, headers)
+      end
+
+      def error_response(response)
+        error_response = VerifyKit::Responses::Error.new(response.body)
+        Failure(error_response)
+      end
+
+      def success_response(response)
+        success_response = VerifyKit::Responses::Success.new(response.body)
+        Success(success_response)
+      end
+    end
+  end
+end

data/lib/verify_kit/resources/sms.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module VerifyKit
+  module Resources
+    class SMS < VerifyKit::Resources::Base
+      def send(body = {}, params = {})
+        response = post_request('send-otp', body: body, params: params)
+        return error_response(response) unless response.success?
+
+        success_response(response)
+      end
+
+      def check(body = {}, params = {})
+        response = post_request('check-otp', body: body, params: params)
+        return error_response(response) unless response.success?
+
+        success_response(response)
+      end
+    end
+  end
+end

data/lib/verify_kit/resources/whatsapp.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module VerifyKit
+  module Resources
+    class WhatsApp < VerifyKit::Resources::Base
+      def send(body = {}, params = {})
+        body[:app] = 'whatsapp'
+
+        response = post_request('start', body: body, params: params)
+        return error_response(response) unless response.success?
+
+        success_response(response)
+      end
+
+      def check(body = {}, params = {})
+        response = post_request('check-whatsapp', body: body, params: params)
+        return error_response(response) unless response.success?
+
+        success_response(response)
+      end
+    end
+  end
+end

data/lib/verify_kit/responses/base.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'dry-struct'
+
+module VerifyKit
+  module Responses
+    class Base < Dry::Struct
+      transform_keys(&:to_sym)
+    end
+  end
+end

data/lib/verify_kit/responses/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module VerifyKit
+  module Responses
+    class Error < VerifyKit::Responses::Base
+      attribute :meta, Types::Hash
+    end
+  end
+end

data/lib/verify_kit/responses/success.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module VerifyKit
+  module Responses
+    class Success < VerifyKit::Responses::Base
+      attribute :meta, Types::Hash
+      attribute :result, Types::Hash
+    end
+  end
+end

data/lib/verify_kit/types.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'dry-types'
+
+module VerifyKit
+  module Types
+    include Dry::Types()
+  end
+end

data/lib/verify_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VerifyKit
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

data/lib/verify_kit.rb

@@ -1,8 +1,30 @@
 # frozen_string_literal: true
 
-require_relative 'verify_kit/version'
+require 'zeitwerk'
+require 'logger'
+require 'dry-configurable'
+require 'dry/configurable/test_interface'
+
+loader = Zeitwerk::Loader.for_gem.tap do |l|
+  l.inflector.inflect(
+    'sms' => 'SMS',
+    'Sms' => 'SMS',
+    'whatsapp' => 'WhatsApp',
+    'Whatsapp' => 'WhatsApp'
+  )
+end
+
+loader.setup
 
 module VerifyKit
-  class Error < StandardError; end
-  # Your code goes here...
+  extend Dry::Configurable
+
+  enable_test_interface
+
+  setting :server_key, default: nil, reader: true
+  setting :api_version, default: 'v1.0', reader: true
+  setting :logger, default: Logger.new($stdout), reader: true
+  setting :debug do
+    setting :enabled, default: false, reader: true
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: verifykit
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - nejdetkadir
@@ -9,7 +9,135 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2023-05-09 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.4
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.8
 description: Ruby bindings for VerifyKit REST API. VerifyKit is a service that offers
   alternative channels alongside SMS for phone number verification and it enables
   your users to log in or sign up to your apps quickly.
@@ -29,6 +157,15 @@ files:
 - Rakefile
 - docs/cover.png
 - lib/verify_kit.rb
+- lib/verify_kit/client.rb
+- lib/verify_kit/core/service.rb
+- lib/verify_kit/resources/base.rb
+- lib/verify_kit/resources/sms.rb
+- lib/verify_kit/resources/whatsapp.rb
+- lib/verify_kit/responses/base.rb
+- lib/verify_kit/responses/error.rb
+- lib/verify_kit/responses/success.rb
+- lib/verify_kit/types.rb
 - lib/verify_kit/version.rb
 - sig/verifykit.rbs
 homepage: https://github.com/nejdetkadir/verifykit