uid2 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca62bf4baf03040acd589422b287455bf830b29b7169754a18dd8191dc031e4f
-  data.tar.gz: 34f3b2736cc70383184cb69ea742e73469e06a274cabfcb53275081698cdc982
+  metadata.gz: 63c73ef45bda732e21922cc4f6a8fab9ed68471f1361cac468bef5199934ceb9
+  data.tar.gz: 4fcdfbc699215daddd062b2032fdd5b0640817eca754ea6a584111a893f0df4a
 SHA512:
-  metadata.gz: b635f3d73fae3870b3a698f6c2beeffdece28daba803f590324b6f9c6a59d01d441e56b79d13410709bd4555a300149c4c9b40e1041e35c6b5e0653c5b004741
-  data.tar.gz: 4482a0398dafb9c9af3e438ba837dbb67c0b508f2dead329cd33066b3e9c881aa4d77473fe5a2f1df8d6fc087eb86bcb32add1e8c2a46f82cde5169e7295913d
+  metadata.gz: 57d5aa6003cd365972157c588493fbb5b90508e1e681ed3ad5fa563dd814fbabad419129665c07c96b1ae10a516dfd95348de825ede173a8a03bb4f19366dd3c
+  data.tar.gz: 838a537bce16ff6d5cb0c24a4373737a7b46dda1309b1d987d8cfcb4032a64454ddb7e8c50c8d7b81751b6a3f58c8f4e0423701c681430b32942e2a6f970f3c5

data/.github/workflows/main.yml

@@ -10,7 +10,7 @@ jobs:
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.7.2
+        ruby-version: 3.1.2
         bundler-cache: true
     - name: Run the default task
       run: bundle exec rake

data/Gemfile

@@ -2,11 +2,8 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in uid2.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.7"
+gem "rake"
+gem "rspec"
+gem "standard"

data/Gemfile.lock

@@ -0,0 +1,96 @@
+PATH
+  remote: .
+  specs:
+    uid2 (0.2.0)
+      faraday (>= 1)
+      faraday_middleware (>= 1)
+      hashie (>= 4)
+      net-http-persistent (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    connection_pool (2.2.5)
+    diff-lcs (1.5.0)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    hashie (5.0.0)
+    multipart-post (2.2.3)
+    net-http-persistent (4.0.1)
+      connection_pool (~> 2.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake
+  rspec
+  standard
+  uid2!
+
+BUNDLED WITH
+   2.3.16

data/README.md

@@ -1,8 +1,8 @@
-# Uid2
+# UID2 - A Ruby API client for Unified ID 2.0
 
-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/uid2`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem provides an API client for [Unified ID 2.0](https://github.com/UnifiedID2/uid2docs). 
 
-TODO: Delete this and the text above, and describe your gem
+Current supports UID2 API v2.
 
 ## Installation
 
@@ -12,17 +12,34 @@ Add this line to your application's Gemfile:
 gem 'uid2'
 ```
 
-And then execute:
+## Usage
 
-    $ bundle install
+This gem implements every Unified ID 2.0 APIs.
 
-Or install it yourself as:
+To create a client:
 
-    $ gem install uid2
+```ruby
+client = Uid2::Client.new do |client|
+  c.bearer_token = "YOUR_TOKEN_HERE"
+  c.secret_key = "YOUR_SECRET_KEY_HERE"
+end
+```
 
-## Usage
+Then call methods:
+
+```ruby
+# To generate UID2 token
+client.generate_token(email: 'foo@bar.com')
+client.generate_token(phone: '+886912345678')
+
+# To map UID2 identity
+client.generate_identifier(email: 'foo@bar.com')
+client.generate_identifier(phone: '+886912345678')
+
+# To get salt buckets
+client.get_salt_buckets
+```
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -32,7 +49,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/uid2. 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/[USERNAME]/uid2/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/polydice/uid2. 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/[USERNAME]/uid2/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/faraday/uid2/middleware.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "base64"
+require "hashie/mash"
+
+module Faraday
+  module Uid2
+    class Middleware < Faraday::Middleware
+      def initialize(app, secret_key, is_refresh, options = {})
+        super(app, options)
+
+        @key = Base64.decode64(secret_key)
+        @is_refresh = is_refresh
+      end
+
+      def call(request_env)
+        unless @is_refresh
+          @nonce = Random.new.bytes(8)
+
+          cipher = create_cipher.encrypt
+          iv = cipher.random_iv
+
+          body = request_env.body
+          payload = timestamp_bytes + @nonce + body
+          encrypted = cipher.update(payload) + cipher.final
+          request_env.body = Base64.strict_encode64(["\x1", iv, encrypted, cipher.auth_tag].join)
+        end
+
+        @app.call(request_env).on_complete do |response_env|
+          process_response(response_env)
+        end
+      end
+
+      def process_response(env)
+        resp = Base64.decode64(env.body).unpack("C*")
+        iv = resp[0..11].pack("C*")
+        cipher_text = resp[12...-16].pack("C*")
+        auth_tag = resp[-16...-1].pack("C*")
+
+        cipher = create_cipher.decrypt
+        cipher.iv = iv
+        cipher.auth_tag = auth_tag
+
+        payload = cipher.update(cipher_text) + cipher.final
+
+        data = if @is_refresh
+          payload
+        else
+          timestamp = Time.at(payload[0..7].unpack1("Q>") / 1000.0)
+          raise Faraday::ParsingError.new("Response timestamp is too old", env[:response]) if Time.now - timestamp > 5 * 60
+
+          nonce = payload[8..15]
+          raise Faraday::ParsingError.new("Nonce mismatch", env[:response]) if nonce != @nonce
+
+          payload[16..]
+        end
+
+        env.response_headers["Content-Type"] = "application/json"
+        env.body = Hashie::Mash.new(JSON.parse(data))
+      end
+
+      def timestamp_bytes
+        [(Time.now.to_f * 1000).to_i].pack("Q>")
+      end
+
+      def create_cipher
+        cipher = OpenSSL::Cipher.new("aes-256-gcm").encrypt
+        cipher.padding = 0
+        cipher.key = @key
+        cipher.auth_data = ""
+        cipher
+      end
+    end
+  end
+end

data/lib/faraday/uid2.rb

@@ -0,0 +1,8 @@
+require_relative "uid2/middleware"
+require "faraday"
+
+module Faraday
+  module Uid2
+    Faraday::Request.register_middleware uid2_encryption: Middleware
+  end
+end

data/lib/uid2/client.rb

@@ -3,77 +3,45 @@
 require "net/http/persistent"
 require "faraday"
 require "faraday_middleware"
+require "faraday/uid2"
 require "time"
 
 module Uid2
   class Client
-    attr_accessor :bearer_token, :base_url
+    attr_accessor :bearer_token, :base_url, :secret_key
 
     def initialize(_options = {})
       yield(self) if block_given?
 
-      self.base_url ||= "https://integ.uidapi.com/v1/"
+      self.base_url ||= "https://prod.uidapi.com/v2/"
     end
 
-    def generate_token(email: nil, email_hash: nil)
-      raise ArgumentError, "Either email or email_hash needs to be provided" if email.nil? && email_hash.nil?
-
-      # As stated in doc, if email and email_hash are both supplied in the same request,
-      # only the email will return a mapping response.
-      params = if email.empty?
-                 { email_hash: email_hash }
-               else
-                 { email: email }
-               end
-      http.get("token/generate", params).body
+    def generate_token(email: nil, email_hash: nil, phone: nil, phone_hash: nil)
+      params = {email: email, email_hash: email_hash, phone: phone, phone_hash: phone_hash}.reject { |_, v| v.nil? }
+      raise ArgumentError, "One of the argument needs to be provided" if params.empty?
+      http.post("token/generate", params).body
     end
 
-    def validate_token(token:, email: nil, email_hash: nil)
-      raise ArgumentError, "Either email or email_hash needs to be provided" if email.nil? && email_hash.nil?
-
-      params = if email.empty?
-                 { email_hash: email_hash }
-               else
-                 { email: email }
-               end
+    def validate_token(token:, email: nil, email_hash: nil, phone: nil, phone_hash: nil)
+      params = {email: email, email_hash: email_hash, phone: phone, phone_hash: phone_hash}.reject { |_, v| v.nil? }
+      raise ArgumentError, "One of the argument needs to be provided" if params.empty?
 
-      http.get("token/validate", params.merge(token: token)).body
+      http.post("token/validate", params.merge(token: token)).body
     end
 
-    def refresh_token(refresh_token:)
-      http.get("token/refresh", { refresh_token: refresh_token }).body
+    def refresh_token(refresh_token:, refresh_response_key:)
+      http(is_refresh: true, refresh_response_key: refresh_response_key).post("token/refresh", refresh_token).body
     end
 
     def get_salt_buckets(since: Time.now)
       # By default, Ruby's iso8601 generates timezone parts (`T`)
       # which needs to be removed for UID2 APIs
-      http.get("identity/buckets", since_timestamp: since.utc.iso8601[0..-2]).body
+      http.post("identity/buckets", since_timestamp: since.utc.iso8601[0..-2]).body
     end
 
-    def generate_identifier(email: nil, email_hash: nil)
-      raise ArgumentError, "Either email or email_hash needs to be provided" if email.nil? && email_hash.nil?
-
-      # As stated in doc, if email and email_hash are both supplied in the same request,
-      # only the email will return a mapping response.
-      params = if email.empty?
-                 { email_hash: email_hash }
-               else
-                 { email: email }
-               end
-
-      http.get("identity/map", params).body
-    end
-
-    def batch_generate_identifier(email: nil, email_hash: nil)
-      raise ArgumentError, "Either email or email_hash needs to be provided" if email.nil? && email_hash.nil?
-
-      # As stated in doc, if email and email_hash are both supplied in the same request,
-      # only the email will return a mapping response.
-      params = if email.empty?
-                 { email_hash: Array(email_hash) }
-               else
-                 { email: Array(email) }
-               end
+    def generate_identifier(email: nil, email_hash: nil, phone: nil, phone_hash: nil)
+      params = {email: Array(email), email_hash: Array(email_hash), phone: Array(phone), phone_hash: Array(phone_hash)}.reject { |_, v| v.empty? }
+      raise ArgumentError, "One of the argument needs to be provided" if params.empty?
 
       http.post("identity/map", params).body
     end
@@ -86,17 +54,13 @@ module Uid2
       }
     end
 
-    def http
-      @http ||= Faraday.new(
+    def http(is_refresh: false, refresh_response_key: nil)
+      Faraday.new(
         url: base_url,
         headers: credentials
       ) do |f|
-        f.request :json
-
-        f.response :raise_error
-        f.response :mashify
-        f.response :json
-
+        f.request :json unless refresh_response_key
+        f.request :uid2_encryption, refresh_response_key || secret_key, is_refresh
         f.adapter :net_http_persistent
       end
     end

data/lib/uid2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Uid2
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/uid2.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "uid2/version"
+
+require_relative "faraday/uid2"
 require_relative "uid2/client"

data/uid2.gemspec

@@ -3,15 +3,15 @@
 require_relative "lib/uid2/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "uid2"
-  spec.version       = Uid2::VERSION
-  spec.authors       = ["Richard Lee"]
-  spec.email         = ["14349+dlackty@users.noreply.github.com"]
+  spec.name = "uid2"
+  spec.version = Uid2::VERSION
+  spec.authors = ["Richard Lee"]
+  spec.email = ["14349+dlackty@users.noreply.github.com"]
 
-  spec.summary       = "Ruby API client for Unified ID 2.0"
-  spec.description   = spec.summary
-  spec.homepage      = "https://github.com/polydice/uid2"
-  spec.license       = "MIT"
+  spec.summary = "Ruby API client for Unified ID 2.0"
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/polydice/uid2"
+  spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: uid2
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Richard Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-07 00:00:00.000000000 Z
+date: 2022-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -80,11 +80,14 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- lib/faraday/uid2.rb
+- lib/faraday/uid2/middleware.rb
 - lib/uid2.rb
 - lib/uid2/client.rb
 - lib/uid2/version.rb
@@ -111,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Ruby API client for Unified ID 2.0