tenios-api 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b0911331d2acc593d17afe8263e9955e9b0e7ce82d632b09c5d9586a23eff13
-  data.tar.gz: 7d2d7ca7ec66d8b21a0ffda096a293a1e1305b7e6824300515741ba5f032d1eb
+  metadata.gz: c8f4b1e8779c3b969fddafc92b7291a802319c6f581097510f59749708eadf70
+  data.tar.gz: edcf7cc2aad2bac65b6e088e34f8c735a79309f6e36adf676433a78fa3c75967
 SHA512:
-  metadata.gz: 02334eb4c0304b31227505016987ac23a42f2ac66610c8799d26dfe6ec7abb4231310c700447b85294ab22afba07473802561ab9e06aeeb5357cea7ecebe818f
-  data.tar.gz: 9dc6a38fd7dea49f3686ba45dc3ca09946bfdf1ec9f8353b9158b57dd8b1706604705ad0abfedc4468927f8397f041c096dbb7a991734783291c4765c9564b3a
+  metadata.gz: 90e98323495cbc63cd7bf8f024ee0b245dd3ee4d2c9538beeacf01aae55a1527a25d4f5a7b02e15741fdb5a74bde3074f1740ebce92351764f45df0f07b9ce9b
+  data.tar.gz: f16d05a78e70aee4af849720d0a30b2c7caeac4a2d315ae696b7c10cc25075d4c4ab7a49ab18554b9552891f062556ba2f8c1c0364331350289dfcbfaae6da94

data/.circleci/config.yml

@@ -1,54 +1,34 @@
-ruby: &ruby
-  image: carwow/ruby-ci:2.6
-
-version: 2
+version: 2.1
 
 jobs:
-  bundle:
-    working_directory: ~/tenios-api
+  test:
+    parameters:
+      ruby_version:
+        type: string
     docker:
-      - *ruby
+      - image: cimg/ruby:<< parameters.ruby_version >>
     steps:
       - checkout
       - restore_cache:
-          keys:
-            - bundle-{{ checksum "Gemfile.lock" }}
-            - bundle-
-      - run: |
-          bundle config --local path vendor/bundle &&
-          bundle check || bundle install --jobs=4 --retry=3
+          keys: 
+            - bundle
+      - run:
+          name: bundle update
+          command: |
+            bundle config --local path vendor/bundle
+            bundle update --jobs=4 --retry=3
+            bundle clean --force
       - save_cache:
-          key: bundle-{{ checksum "Gemfile.lock" }}
-          paths: [~/tenios-api/vendor/bundle]
-      - persist_to_workspace:
-          root: '~'
-          paths: [tenios-api]
-
-  rubocop:
-    working_directory: ~/tenios-api
-    docker:
-      - *ruby
-    steps:
-      - attach_workspace:
-          at: '~'
-      - run: bundle exec rubocop
-
-  tests:
-    working_directory: ~/tenios-api
-    docker:
-      - *ruby
-    steps:
-      - attach_workspace:
-          at: '~'
-      - run: |
-          bundle exec rspec
+          key: bundle
+          paths: [~/project/vendor/bundle]
+      - run: bundle exec rake
 
 workflows:
   version: 2
-  build:
+  test:
     jobs:
-      - bundle
-      - rubocop:
-          requires: [bundle]
-      - tests:
-          requires: [bundle]
+      - test:
+          matrix:
+            parameters:
+              ruby_version:
+                - "2.7"

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/Gemfile.lock
 
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## [1.0.0]
+
+### Changed
+
+* Tenios API URL is now https://api.tenios.com
+* Ruby ~> 2.7
+
+### Misc
+
+* Internal refactoring (no breaking changes)
+
+[1.0.0]: https://github.com/carwow/deals_service_client/compare/v0.4.0...v1.0.0

data/Gemfile

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

data/README.md

@@ -24,8 +24,10 @@ client = Tenios::API::Client.new(access_key: ENV['TENIOS_ACCESS_KEY'])
 
 [Tenios documentation](https://www.tenios.de/en/doc/api-cdr-request)
 
+#### Retrive
+
 ```ruby
-client.cdrs.retrieve(Time.utc(2019, 2, 1)..Time.utc(2019, 2, 2))
+client.call_detail_records.retrieve(Time.utc(2019, 2, 1)..Time.utc(2019, 2, 2))
 # returns lazy Enumerator with the records
 ```
 
@@ -33,12 +35,46 @@ client.cdrs.retrieve(Time.utc(2019, 2, 1)..Time.utc(2019, 2, 2))
 
 [Tenios documentation](https://www.tenios.de/en/doc/api-number-order)
 
+#### Verification
+
 ```ruby
 # check Tenios documentation for verification options
 verification_id = client.verification.create(options)['verification_id']
+```
+
+#### Order
+
+```ruby
 order_id = client.number.order(verification_id: verification_id)['order_id']
 ```
 
+#### Cancel
+
+```ruby
+client.number.cancel(phone_number: '+49888888')
+```
+
+### Record Call
+
+[Tenios documentation](https://www.tenios.de/en/doc/api-call-recording)
+
+#### Start
+
+```ruby
+recording_uuid = client.record_call.start(
+  call_uuid: '9315b018-86bd-424f-a086-7095ce427130'
+)['recording_uuid']
+```
+
+#### Stop
+
+```ruby
+client.record_call.stop(
+  call_uuid: '9315b018-86bd-424f-a086-7095ce427130',
+  recording_uuid: recording_uuid
+)
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/carwow/tenios-api-ruby.

data/Rakefile

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

data/bin/console

@@ -1,10 +1,7 @@
 #!/usr/bin/env ruby
 
-lib = File.expand_path("../lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
 require "bundler/setup"
-require "tenios/api"
+require "tenios-api"
 require "pry"
 
 Pry.start

data/lib/tenios-api.rb

@@ -1,3 +1,9 @@
 # frozen_string_literal: true
 
-require 'tenios/api'
+require "zeitwerk"
+
+Zeitwerk::Loader.for_gem.tap do |loader|
+  loader.ignore "#{__dir__}/tenios-api.rb"
+  loader.inflector.inflect "api" => "API"
+  loader.setup
+end

data/lib/tenios/api/call_detail_records.rb

@@ -12,7 +12,7 @@ module Tenios
       def retrieve(date_range, page_size: 100)
         stream do |page|
           payload = build_payload(date_range, page: page, page_size: page_size)
-          client.http_client.post('/cdrs/retrieve', payload).body
+          client.post("/cdrs/retrieve", payload)
         end
       end
 
@@ -22,7 +22,6 @@ module Tenios
         expect_date_range! date_range
 
         {
-          access_key: client.access_key,
           start_date_from: format_datetime(date_range.begin),
           start_date_to: format_datetime(date_range.end),
           page: page,
@@ -39,17 +38,17 @@ module Tenios
       end
 
       def format_datetime(time)
-        time.utc.strftime('%FT%H:%M:%S.0Z')
+        time.utc.strftime("%FT%H:%M:%S.0Z")
       end
 
       def stream
-        Enumerator.new do |records|
+        Enumerator.new { |records|
           (1..Float::INFINITY).each do |page|
             res = yield page
-            res['items'].each { |item| records << item }
-            break if res['total_items'] <= page * res['page_size']
+            res["items"].each { |item| records << item }
+            break if res["total_items"] <= page * res["page_size"]
           end
-        end.lazy
+        }.lazy
       end
     end
   end

data/lib/tenios/api/client.rb

@@ -1,47 +1,52 @@
 # frozen_string_literal: true
 
-require 'json'
-require 'faraday'
-require 'faraday_middleware'
+require "json"
+require "faraday"
+require "faraday_middleware"
 
 module Tenios
   module API
     class Client
-      attr_reader :access_key
+      URL = "https://api.tenios.com"
 
-      def initialize(access_key:)
+      def initialize(access_key:, url: URL)
         @access_key = access_key
+        @http_client = build_http_client(url)
       end
 
-      def http_client
-        @http_client ||= Faraday.new(url: 'https://api.tevox.com') do |c|
-          c.request :json
-          c.response :json
-          c.response :raise_error
-          c.use :gzip
+      def call_detail_records
+        CallDetailRecords.new(self)
+      end
 
-          c.adapter Faraday.default_adapter
-        end
+      def verification
+        Verification.new(self)
       end
 
-      class <<self
-        private
+      def number
+        Number.new(self)
+      end
 
-        def endpoint(name, klass)
-          API.autoload klass, "tenios/api/#{name}"
+      def record_call
+        RecordCall.new(self)
+      end
 
-          class_eval <<~RUBY, __FILE__, __LINE__ + 1
-            def #{name}
-              @#{name} ||= #{klass}.new(self)
-            end
-          RUBY
-        end
+      # @api private
+      def post(path, **payload)
+        @http_client.post(path, payload.merge(access_key: @access_key)).body
       end
 
-      endpoint :call_detail_records, :CallDetailRecords
-      endpoint :verification, :Verification
-      endpoint :number, :Number
-      endpoint :record_call, :RecordCall
+      private
+
+      def build_http_client(url)
+        Faraday.new(url: url) { |c|
+          c.request :json
+          c.response :json
+          c.response :raise_error
+          c.use :gzip
+
+          c.adapter Faraday.default_adapter
+        }
+      end
     end
   end
 end

data/lib/tenios/api/number.rb

@@ -10,17 +10,16 @@ module Tenios
       end
 
       NUMBER_TYPES = [
-        GEOGRAPHICAL = 'GEOGRAPHICAL'
+        GEOGRAPHICAL = "GEOGRAPHICAL"
       ].freeze
 
       def order(verification_id:, number_type: GEOGRAPHICAL, **options)
         payload = order_payload(verification_id: verification_id, number_type: number_type, **options)
-        client.http_client.post('/number/order', payload).body
+        client.post("/number/order", **payload)
       end
 
       def cancel(phone_number:)
-        payload = { access_key: client.access_key, phone_number: phone_number }
-        client.http_client.post('/number/cancel', payload).body
+        client.post("/number/cancel", phone_number: phone_number)
       end
 
       private
@@ -35,9 +34,7 @@ module Tenios
       private_constant :ORDER_OPTIONS
 
       def order_payload(**options)
-        options
-          .slice(*ORDER_OPTIONS)
-          .merge(access_key: client.access_key)
+        options.slice(*ORDER_OPTIONS)
       end
     end
   end

data/lib/tenios/api/record_call.rb

@@ -10,20 +10,11 @@ module Tenios
       end
 
       def start(call_uuid:)
-        client.http_client.post(
-          '/record-call/start',
-          access_key: client.access_key,
-          call_uuid: call_uuid
-        ).body
+        client.post("/record-call/start", call_uuid: call_uuid)
       end
 
       def stop(recording_uuid:, call_uuid:)
-        client.http_client.post(
-          '/record-call/stop',
-          access_key: client.access_key,
-          call_uuid: call_uuid,
-          recording_uuid: recording_uuid
-        ).body
+        client.post("/record-call/stop", call_uuid: call_uuid, recording_uuid: recording_uuid)
       end
     end
   end

data/lib/tenios/api/verification.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'base64'
+require "base64"
 
 module Tenios
   module API
@@ -22,7 +22,7 @@ module Tenios
 
       def create(options)
         payload = build_payload(options)
-        client.http_client.post('/verification/create', payload).body
+        client.post("/verification/create", **payload)
       end
 
       private
@@ -41,9 +41,7 @@ module Tenios
 
       def build_payload(options)
         to_option = build_option(options)
-
         OPTIONS.map(&to_option).to_h
-          .merge(access_key: client.access_key)
       end
 
       def build_option(options)
@@ -61,13 +59,13 @@ module Tenios
         raise ArgumentError, "invalid document_type: #{type}"
       end
 
-      PDF_FILE_SIGNATURE = Base64.encode64('%PDF-')[0..6].freeze
+      PDF_FILE_SIGNATURE = Base64.encode64("%PDF-")[0..6].freeze
       private_constant :PDF_FILE_SIGNATURE
 
       def validate_document_data!(data)
         return if data.start_with? PDF_FILE_SIGNATURE
 
-        raise ArgumentError, 'invalid document_data: should be a base64 encoded pdf file'
+        raise ArgumentError, "invalid document_data: should be a base64 encoded pdf file"
       end
     end
   end

data/lib/tenios/api/version.rb

@@ -2,6 +2,6 @@
 
 module Tenios
   module API
-    VERSION = '0.4.0'
+    VERSION = "1.0.0"
   end
 end

data/tenios-api.gemspec

@@ -1,37 +1,33 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'tenios/api/version'
+require_relative "lib/tenios/api/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'tenios-api'
-  spec.version       = Tenios::API::VERSION
-  spec.authors       = ['carwow Developers']
-  spec.email         = ['developers@carwow.co.uk']
-  spec.summary       = 'Tenios API Client ☎️'
-  spec.description   = 'Get Call Detail Records (CDRs) from Tenios API.'
-  spec.homepage      = 'https://github.com/carwow/tenios-api-ruby'
-  spec.license       = 'MIT'
+  spec.name = "tenios-api"
+  spec.version = Tenios::API::VERSION
+  spec.authors = ["carwow Developers"]
+  spec.email = ["developers@carwow.co.uk"]
+  spec.summary = "Tenios API Client ☎️"
+  spec.description = "Get Call Detail Records (CDRs) from Tenios API."
+  spec.homepage = "https://github.com/carwow/tenios-api-ruby"
+  spec.license = "MIT"
 
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
-  end
+  spec.required_ruby_version = Gem::Requirement.new("~> 2.7")
 
-  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.require_paths = ['lib']
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["homepage_uri"] = "#{spec.homepage}/README.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
 
-  spec.add_dependency 'faraday'
-  spec.add_dependency 'faraday_middleware'
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.start_with? "spec" }
+  spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'carwow_rubocop'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
+  spec.add_dependency "faraday", "~> 1.3"
+  spec.add_dependency "faraday_middleware", "~> 1.0"
+  spec.add_dependency "zeitwerk", "~> 2.4"
+
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "standard", "~> 0.12"
 end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: tenios-api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - carwow Developers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '2.4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: carwow_rubocop
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: standard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.12'
 description: Get Call Detail Records (CDRs) from Tenios API.
 email:
 - developers@carwow.co.uk
@@ -119,14 +119,13 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - lib/tenios-api.rb
-- lib/tenios/api.rb
 - lib/tenios/api/call_detail_records.rb
 - lib/tenios/api/client.rb
 - lib/tenios/api/number.rb
@@ -139,23 +138,26 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+  source_code_uri: https://github.com/carwow/tenios-api-ruby
+  homepage_uri: https://github.com/carwow/tenios-api-ruby/README.md
+  changelog_uri: https://github.com/carwow/tenios-api-ruby/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Tenios API Client ☎️
 test_files: []

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    tenios-api (0.4.0)
-      faraday
-      faraday_middleware
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.0)
-    carwow_rubocop (2.1.1)
-      rubocop (~> 0.58)
-      rubocop-rspec (~> 1.28)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    faraday (1.0.1)
-      multipart-post (>= 1.2, < 3)
-    faraday_middleware (1.0.0)
-      faraday (~> 1.0)
-    jaro_winkler (1.5.2)
-    method_source (0.9.2)
-    multipart-post (2.1.1)
-    parallel (1.13.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    psych (3.1.0)
-    rainbow (3.0.0)
-    rake (13.0.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.65.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      psych (>= 3.1.0)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    rubocop-rspec (1.32.0)
-      rubocop (>= 0.60.0)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  carwow_rubocop
-  pry
-  rake
-  rspec
-  tenios-api!
-
-BUNDLED WITH
-   2.1.4

data/lib/tenios/api.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'tenios/api/client'
-
-module Tenios
-  module API
-    autoload :Version, 'tenios/api/version'
-  end
-end