tenios-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8f391faf118141ffe8aa25f8b03268fe17a042725743f38b01b54a3cf7e6fd7
-  data.tar.gz: 52ff37ed16b3d624c7e5bc637890dd15581f8d0fb38360f0c314e5b05f9f25e8
+  metadata.gz: 432dc3d9f0e7fc555722bad490b36d2f7d4be866df5c3458af6c9044ef6b57eb
+  data.tar.gz: 37128cbd40ba9000eb72429c1c2b3eaab39e9418a7bf775f6c8f7c609eb58edc
 SHA512:
-  metadata.gz: fb2864919b8829eae4b1ef6af31e1aa01f25803a2d1e3db1145bf08a7767cf0b3b80ba685322382e6f7d6fc4792e99becb0069470755777e9b7a9ddd816df3a3
-  data.tar.gz: 64dfb553c6c1c830748b5033054b11feaee46388266ae1827e08e054755988811e07f2a84402d516d4d3dda3e7cd793e1e184038e5b3f9d1e4d9a4df04262c27
+  metadata.gz: b0841faadf6ad05340b1eaa6a3c523fb7bfb4b4f242bc387405a3be241b43b9dfbf4efc5696110564640892e9853b391309a4f7f202c2e3a1f8567713fd2c7b2
+  data.tar.gz: 2485adec0b7a8ae0a43cafca6aeb4d7267e59557973ff497827853a499a734d53e656f59bb0e6bc129e08d475836a39dfbc620fda3f9b552aec0e13ac789c6de

data/.circleci/config.yml

@@ -1,5 +1,5 @@
 ruby: &ruby
-  image: carwow/ruby-ci:2.5.3
+  image: carwow/ruby-ci:2.6
 
 version: 2
 

data/.rubocop.yml

@@ -5,3 +5,9 @@ inherit_gem:
 Naming/FileName:
   Exclude:
     - lib/tenios-api.rb
+
+RSpec/VerifiedDoubles:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: true

data/Gemfile

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tenios-api (0.1.0)
+    tenios-api (0.2.0)
       faraday
       faraday_middleware
 
@@ -12,17 +12,22 @@ GEM
     carwow_rubocop (2.1.1)
       rubocop (~> 0.58)
       rubocop-rspec (~> 1.28)
+    coderay (1.1.2)
     diff-lcs (1.3)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
     jaro_winkler (1.5.2)
-    multipart-post (2.0.0)
+    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 (12.3.2)
@@ -59,9 +64,10 @@ PLATFORMS
 DEPENDENCIES
   bundler
   carwow_rubocop
+  pry
   rake
   rspec
   tenios-api!
 
 BUNDLED WITH
-   1.17.3
+   2.0.2

data/README.md

@@ -1,8 +1,8 @@
 # Tenios API Client ☎️
 
-Get Call Detail Records (CDRs) from [Tenios API].
+HTTP client for [Tenios API].
 
-[Tenios API]: https://www.tenios.de/en/doc/api-cdr-request
+[Tenios API]: https://www.tenios.de/doc-topic/voice-api
 
 ## Installation
 
@@ -18,11 +18,27 @@ gem 'tenios-api'
 require 'tenios-api'
 
 client = Tenios::API::Client.new(access_key: ENV['TENIOS_ACCESS_KEY'])
+```
+
+### Call Detail Records
+
+[Tenios documentation](https://www.tenios.de/en/doc/api-cdr-request)
 
-client.cdrs(Time.new(2019, 2, 1)..Time.new(2019, 2, 2))
+```ruby
+client.cdrs.retrieve(Time.utc(2019, 2, 1)..Time.utc(2019, 2, 2))
 # returns lazy Enumerator with the records
 ```
 
+### Number Order
+
+[Tenios documentation](https://www.tenios.de/en/doc/api-number-order)
+
+```ruby
+# check Tenios documentation for verification options
+verification_id = client.verification.create(options)['verification_id']
+order_id = client.number.order(verification_id: verification_id)['order_id']
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/carwow/tenios-api-ruby.

data/lib/tenios/api/call_detail_records.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Tenios
+  module API
+    class CallDetailRecords
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      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
+        end
+      end
+
+      private
+
+      def build_payload(date_range, page:, page_size:)
+        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,
+          page_size: page_size
+        }
+      end
+
+      def expect_date_range!(date_range)
+        return if %i[begin end].all? { |method| date_range.respond_to? method }
+
+        raise TypeError, <<~ERR.strip
+          Expect date_range to be Range-like (respond_to methods #begin and #end), but was: #{date_range.class}
+        ERR
+      end
+
+      def format_datetime(time)
+        time.utc.strftime('%FT%H:%M:%S.0Z')
+      end
+
+      def stream
+        Enumerator.new do |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']
+          end
+        end.lazy
+      end
+    end
+  end
+end

data/lib/tenios/api/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'faraday'
 require 'faraday_middleware'
@@ -5,6 +7,8 @@ require 'faraday_middleware'
 module Tenios
   module API
     class Client
+      attr_reader :access_key
+
       def initialize(access_key:)
         @access_key = access_key
       end
@@ -20,45 +24,23 @@ module Tenios
         end
       end
 
-      def call_detail_records(start_date, page_size: 100)
-        stream do |page|
-          payload = payload_for_cdrs(start_date, page: page, page_size: page_size)
-          http_client.post('/cdrs/retrieve', payload).body
-        end
-      end
-      alias cdrs call_detail_records
+      class <<self
+        private
 
-      private
+        def endpoint(name, klass)
+          API.autoload klass, "tenios/api/#{name}"
 
-      attr_reader :access_key
-
-      def payload_for_cdrs(start_date, page:, page_size:)
-        unless %i[begin end].all? { |method| start_date.respond_to? method }
-          raise TypeError, 'Expect start_date to be Range-like (respond_to methods #begin and #end)'
+          class_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{name}
+              @#{name} ||= #{klass}.new(self)
+            end
+          RUBY
         end
-
-        {
-          access_key: access_key,
-          start_date_from: format_datetime(start_date.begin),
-          start_date_to: format_datetime(start_date.end),
-          page: page,
-          page_size: page_size
-        }.to_json
       end
 
-      def format_datetime(time)
-        time.utc.strftime('%FT%H:%M:%S.0Z')
-      end
-
-      def stream
-        Enumerator.new do |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']
-          end
-        end.lazy
-      end
+      endpoint :call_detail_records, :CallDetailRecords
+      endpoint :verification, :Verification
+      endpoint :number, :Number
     end
   end
 end

data/lib/tenios/api/number.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Tenios
+  module API
+    class Number
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      NUMBER_TYPES = [
+        GEOGRAPHICAL = 'GEOGRAPHICAL'
+      ].freeze
+
+      def order(verification_id:, number_type: GEOGRAPHICAL, **options)
+        payload = build_payload(verification_id: verification_id, number_type: number_type, **options)
+        client.http_client.post('/number/order', payload).body
+      end
+
+      private
+
+      OPTIONS = %i[
+        link_to_number
+        number_type
+        push_secret
+        push_url
+        verification_id
+      ].freeze
+      private_constant :OPTIONS
+
+      def build_payload(**options)
+        options
+          .slice(*OPTIONS)
+          .merge(access_key: client.access_key)
+      end
+    end
+  end
+end

data/lib/tenios/api/verification.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'base64'
+
+module Tenios
+  module API
+    class Verification
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
+
+      DOCUMENT_TYPES = %w[
+        ALLOCATION_NOTICE
+        IDENTITY_CARD
+        BUSINESS_LICENSE
+        IDENTITY_CARD_AND_BUSINESS_LICENSE
+        CERTIFICATE_OF_REGISTRATION
+        CONTRACT
+      ].freeze
+
+      def create(options)
+        payload = build_payload(options)
+        client.http_client.post('/verification/create', payload).body
+      end
+
+      private
+
+      OPTIONS = %i[
+        area_code
+        city
+        country
+        document_data
+        document_type
+        house_number
+        street
+      ].freeze
+      private_constant :OPTIONS
+
+      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)
+        lambda do |name|
+          value = options.fetch(name)
+          validate = :"validate_#{name}!"
+          send validate, value if respond_to? validate, true
+          [name, value]
+        end
+      end
+
+      def validate_document_type!(type)
+        return if DOCUMENT_TYPES.include? type
+
+        raise ArgumentError, "invalid document_type: #{type}"
+      end
+
+      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'
+      end
+    end
+  end
+end

data/lib/tenios/api/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Tenios
   module API
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'
   end
 end

data/lib/tenios/api.rb

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

data/lib/tenios-api.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'tenios/api'

data/tenios-api.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'tenios/api/version'
@@ -29,6 +31,7 @@ Gem::Specification.new do |spec|
 
   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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tenios-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - carwow Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-21 00:00:00.000000000 Z
+date: 2019-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +126,10 @@ files:
 - Rakefile
 - 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
+- lib/tenios/api/verification.rb
 - lib/tenios/api/version.rb
 - tenios-api.gemspec
 homepage: https://github.com/carwow/tenios-api-ruby
@@ -135,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Tenios API Client ☎️