didww-v3 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22a712d25c5bdfa402c73df24b8529f0e001e97256cf7d84cdfbb8d492af4dcd
-  data.tar.gz: f3fdb4186c6821dd1d9c93744515e0a3eb6d0d1b3da3c1da4d0449dd8d726512
+  metadata.gz: 39b910fbb0b5dc4425cf053fd6cacef936c7c46510f8586d33784cccad18a95e
+  data.tar.gz: 1dae18d3341a93e2a2b4c74d81e224e0402a8c7020bda0053fb685be5186abb2
 SHA512:
-  metadata.gz: de07093d853e4576ea5e18552786f3bb88d3013456a75f2efdaae56a3dbbb2560384d11bd22d1cd42f3cd739c0baf531e190dc70e700fba23bd46e3309861d16
-  data.tar.gz: 2a434cb0c3a17840b8b7490b45078f66bb835f5656241fb98a6f629f6c7ee7305cfe6015366c7b9fbfb47233c02dbfe3292e0408deaf8f80e116b089524f5c0c
+  metadata.gz: eba0ac2332cf5f0f4c1f65155c0714d9ce35f0a96227024d2b3a21ab650c44587c789035cfb3dd995d797a08573e821eb1301e00732f91cdb3732175c163177c
+  data.tar.gz: a1ebd2311fa0b1f190d068a210ccfe583b74e3b6ec83c7ad368f2f2eb69d2bdf7d40b8ad5ddb98ab2828b2061ce20a77a67db2406b9c30e5ed4f417d20454259

data/.github/workflows/tests.yml

@@ -5,6 +5,11 @@ on:
     branches:
       - master
 
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -23,3 +28,55 @@ jobs:
           bundler-cache: true
       - name: Run tests
         run: bundle exec rake
+
+      - name: Generate badge.json
+        if: matrix.ruby == '3.4' && matrix.rails == '~> 8.1'
+        run: |
+          LAST_RUN="coverage/.last_run.json"
+          if [ ! -f "$LAST_RUN" ]; then
+            mkdir -p badge
+            echo '{"schemaVersion":1,"label":"coverage","message":"unknown","color":"lightgrey"}' > badge/badge.json
+            exit 0
+          fi
+          PERCENT=$(ruby -rjson -e "puts JSON.parse(File.read('$LAST_RUN')).dig('result','line').round(1)")
+          PERCENT_NUM=$(ruby -rjson -e "puts JSON.parse(File.read('$LAST_RUN')).dig('result','line')")
+          if ruby -e "exit(($PERCENT_NUM >= 90) ? 0 : 1)"; then COLOR="brightgreen"
+          elif ruby -e "exit(($PERCENT_NUM >= 75) ? 0 : 1)"; then COLOR="green"
+          elif ruby -e "exit(($PERCENT_NUM >= 60) ? 0 : 1)"; then COLOR="yellow"
+          else COLOR="red"; fi
+          mkdir -p badge
+          echo "{\"schemaVersion\":1,\"label\":\"coverage\",\"message\":\"${PERCENT}%\",\"color\":\"${COLOR}\"}" > badge/badge.json
+
+      - name: Upload badge artifact
+        if: matrix.ruby == '3.4' && matrix.rails == '~> 8.1'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-badge
+          path: badge
+
+  deploy-coverage:
+    needs: test
+    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Download coverage badge
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-badge
+          path: coverage
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: coverage
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

data/README.md

@@ -1,7 +1,9 @@
 Ruby client for DIDWW API v3.
 
 ![Tests](https://github.com/didww/didww-v3-ruby/workflows/Tests/badge.svg)
+![Coverage](https://img.shields.io/endpoint?url=https://didww.github.io/didww-v3-ruby/badge.json)
 [![Gem Version](https://badge.fury.io/rb/didww-v3.svg)](https://badge.fury.io/rb/didww-v3)
+![Ruby](https://img.shields.io/badge/ruby-3.3%2B-blue)
 
 About DIDWW API v3
 -----
@@ -10,8 +12,12 @@ The DIDWW API provides a simple yet powerful interface that allows you to fully
 
 The DIDWW API v3 is a fully compliant implementation of the [JSON API specification](http://jsonapi.org/format/).
 
+This SDK uses [json_api_client](https://github.com/JsonApiClient/json_api_client) for JSON:API serialization and deserialization.
+
 Read more https://doc.didww.com/api
 
+This SDK sends the `X-DIDWW-API-Version: 2022-05-10` header with every request by default.
+
 Gem Versions **4.X.X** and branch [master](https://github.com/didww/didww-v3-ruby) are intended to use with DIDWW API 3 version [2022-05-10](https://doc.didww.com/api3/2022-05-10/index.html).
 
 Gem Versions **3.X.X** and branch [release-3](https://github.com/didww/didww-v3-ruby/tree/release-3) are intended to use with DIDWW API 3 version [2021-12-15](https://doc.didww.com/api3/2021-12-15/index.html).
@@ -36,22 +42,155 @@ Or install it yourself as:
 
     $ gem install didww-v3
 
-## Usage
+## Requirements
+
+- Ruby 3.3+
+
+## Quick Start
 
 ```ruby
 require 'didww'
 
 client = DIDWW::Client.configure do |config|
-  config.api_key  = '34ffe988432b980f4ba19432539b704f'
+  config.api_key  = 'YOUR_API_KEY'
   config.api_mode = :sandbox
 end
 
-client.balance
+# Check balance
+balance = client.balance
+puts "Balance: #{balance.total_balance}"
+
+# List DID groups with stock keeping units
+did_groups = client.did_groups.all(
+  include: 'stock_keeping_units',
+  filter: { area_name: 'Acapulco' }
+)
+
+puts "DID groups: #{did_groups.count}"
+```
+
+For more examples visit [examples](examples/).
+
+For details on obtaining your API key please visit https://doc.didww.com/api3/configuration.html
+
+## Examples
+
+- Source code: [examples/](examples/)
+- How to run: [examples/README.md](examples/README.md)
+- Rails integration sample: https://github.com/didww/didww-v3-rails-sample
+
+## Configuration
+
+```ruby
+require 'didww'
+
+# Sandbox
+DIDWW::Client.configure do |config|
+  config.api_key  = 'YOUR_API_KEY'
+  config.api_mode = :sandbox
+end
+
+# Production
+DIDWW::Client.configure do |config|
+  config.api_key  = 'YOUR_API_KEY'
+  config.api_mode = :production
+end
+```
+
+### Environments
+
+| Environment | Base URL |
+|-------------|----------|
+| `:production` | `https://api.didww.com/v3/` |
+| `:sandbox` | `https://sandbox-api.didww.com/v3/` |
+
+### API Version
+
+The SDK sends `X-DIDWW-API-Version: 2022-05-10` by default. You can override it per block:
+
+```ruby
+DIDWW::Client.with_api_version('2022-05-10') do
+  DIDWW::Client.countries.all
+end
+```
+
+## Resources
+
+### Read-Only Resources
+
+```ruby
+# Countries
+countries = DIDWW::Client.countries.all
+country = DIDWW::Client.countries.find('uuid')
+
+# Regions, Cities, Areas, POPs
+regions = DIDWW::Client.regions.all
+cities = DIDWW::Client.cities.all
+areas = DIDWW::Client.areas.all
+pops = DIDWW::Client.pops.all
+
+# DID Group Types
+types = DIDWW::Client.did_group_types.all
+
+# DID Groups (with stock keeping units)
+did_groups = DIDWW::Client.did_groups.all(include: 'stock_keeping_units')
+
+# Available DIDs (with DID group and stock keeping units)
+available_dids = DIDWW::Client.available_dids.all(include: 'did_group.stock_keeping_units')
+
+# Public Keys
+public_keys = DIDWW::Client.public_keys.all
+
+# Requirements
+requirements = DIDWW::Client.requirements.all
+
+# Balance (singleton)
+balance = DIDWW::Client.balance
+```
+
+### DIDs
+
+```ruby
+# List DIDs
+dids = DIDWW::Client.dids.all
+
+# Update DID
+did = DIDWW::Client.dids.find('uuid')
+did.description = 'Updated'
+did.capacity_limit = 20
+did.save
 ```
 
-For details on obtaining your API key please visit https://doc.didww.com/api#introduction-api-keys
+### Voice In Trunks
 
-See integration example at https://github.com/didww/didww-v3-rails-sample
+```ruby
+trunk = DIDWW::Client.voice_in_trunks.new(
+  name: 'My SIP Trunk',
+  configuration: {
+    type: 'sip_configurations',
+    host: 'sip.example.com',
+    port: 5060
+  }
+)
+
+trunk.save
+```
+
+### Orders
+
+```ruby
+order = DIDWW::Client.orders.new(
+  items: [
+    {
+      type: 'did_order_items',
+      sku_id: 'sku-uuid',
+      qty: 2
+    }
+  ]
+)
+
+order.save
+```
 
 ## Resource Relationships
 

data/lib/didww/client.rb

@@ -12,8 +12,10 @@ module DIDWW
       production: 'https://api.didww.com/v3/'.freeze
     }.freeze
     DEFAULT_MODE = :sandbox
+    DEFAULT_API_VERSION = '2022-05-10'
 
     mattr_accessor :api_key, :api_mode, :http_verbose, :api_version
+    self.api_version = DEFAULT_API_VERSION
 
     class << self
       def configure
@@ -147,6 +149,22 @@ module DIDWW
         Resource::RequirementValidation
       end
 
+      def areas
+        Resource::Area
+      end
+
+      def proof_types
+        Resource::ProofType
+      end
+
+      def supporting_document_templates
+        Resource::SupportingDocumentTemplate
+      end
+
+      def public_keys
+        Resource::PublicKey
+      end
+
       def api_mode=(arg)
         unless BASE_URLS.keys.include?(arg)
           raise ArgumentError.new("Mode should be in #{BASE_URLS.keys} (given '#{arg}').")
@@ -183,6 +201,7 @@ module DIDWW
         require 'didww/resource/country'
         require 'didww/resource/did_group_type'
         require 'didww/resource/did_group'
+        require 'didww/resource/exclusive_relationship'
         require 'didww/resource/did'
         require 'didww/resource/order'
         require 'didww/resource/pop'

data/lib/didww/resource/did.rb

@@ -2,6 +2,8 @@
 module DIDWW
   module Resource
     class Did < Base
+      include ExclusiveRelationship
+
       has_one :did_group
       has_one :order
       has_one :voice_in_trunk
@@ -10,6 +12,8 @@ module DIDWW
       has_one :shared_capacity_group
       has_one :address_verification
 
+      exclusive_relationships(voice_in_trunk: :voice_in_trunk_group)
+
       property :blocked, type: :boolean
       # Type: Boolean
       # Description: Identifier for a blocked DID. Blocked DIDs are numbers that have expired, have been cancelled or have been suspended by DIDWW.

data/lib/didww/resource/exclusive_relationship.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+module DIDWW
+  module Resource
+    module ExclusiveRelationship
+      class Relations < JsonApiClient::Relationships::Relations
+        def initialize(record_class, relations, exclusions)
+          @exclusions = exclusions
+          @_initializing = true
+          super(record_class, relations)
+          @_initializing = false
+        end
+
+        def set_attribute(name, value)
+          super
+          return if @_initializing
+          exclusive = @exclusions[name.to_s]
+          if exclusive && !value.nil?
+            super(exclusive, nil)
+          end
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def exclusive_relationships(mapping)
+          full_mapping = {}
+          mapping.each do |a, b|
+            full_mapping[a.to_s] = b.to_s
+            full_mapping[b.to_s] = a.to_s
+          end
+          full_mapping.freeze
+
+          define_method(:_exclusive_relationship_mapping) { full_mapping }
+
+          define_method(:relationships) do
+            @relationships ||= Relations.new(self.class, {}, full_mapping)
+          end
+
+          define_method(:relationships=) do |rels|
+            attrs = case rels
+                    when JsonApiClient::Relationships::Relations then rels.attributes
+                    when Hash then rels
+                    else rels || {}
+                    end
+            @relationships = Relations.new(self.class, attrs, full_mapping)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/didww/resource/export.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 require 'forwardable'
 require 'down/http'
+require 'zlib'
+require 'stringio'
 require 'didww/callback/const'
 
 module DIDWW
@@ -52,9 +54,21 @@ module DIDWW
         super params.reverse_merge(filters: {})
       end
 
-      def csv
+      def download
         return unless url.present?
-        Down::Http.new(headers: { 'Api-Key' => DIDWW::Client.api_key }).open(url)
+        Down::Http.new(headers: { 'Api-Key' => DIDWW::Client.api_key, 'X-DIDWW-API-Version' => DIDWW::Client.api_version }).open(url)
+      end
+
+      def csv
+        file = download
+        return unless file
+        gz = Zlib::GzipReader.new(file)
+        begin
+          StringIO.new(gz.read)
+        ensure
+          gz.close unless gz.closed?
+          file.close if file.respond_to?(:close) && !file.closed?
+        end
       end
 
       def complete?

data/lib/didww/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module DIDWW
-  VERSION = '5.0.0'.freeze
+  VERSION = '5.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: didww-v3
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Alex Korobeinikov
@@ -145,6 +145,7 @@ files:
 - lib/didww/resource/did_group_type.rb
 - lib/didww/resource/did_reservation.rb
 - lib/didww/resource/encrypted_file.rb
+- lib/didww/resource/exclusive_relationship.rb
 - lib/didww/resource/export.rb
 - lib/didww/resource/identity.rb
 - lib/didww/resource/nanpa_prefix.rb