tenios-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8f391faf118141ffe8aa25f8b03268fe17a042725743f38b01b54a3cf7e6fd7
+  data.tar.gz: 52ff37ed16b3d624c7e5bc637890dd15581f8d0fb38360f0c314e5b05f9f25e8
+SHA512:
+  metadata.gz: fb2864919b8829eae4b1ef6af31e1aa01f25803a2d1e3db1145bf08a7767cf0b3b80ba685322382e6f7d6fc4792e99becb0069470755777e9b7a9ddd816df3a3
+  data.tar.gz: 64dfb553c6c1c830748b5033054b11feaee46388266ae1827e08e054755988811e07f2a84402d516d4d3dda3e7cd793e1e184038e5b3f9d1e4d9a4df04262c27

data/.circleci/config.yml

@@ -0,0 +1,54 @@
+ruby: &ruby
+  image: carwow/ruby-ci:2.5.3
+
+version: 2
+
+jobs:
+  bundle:
+    working_directory: ~/tenios-api
+    docker:
+      - *ruby
+    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
+      - 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
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - bundle
+      - rubocop:
+          requires: [bundle]
+      - tests:
+          requires: [bundle]

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_gem:
+  carwow_rubocop:
+    - default.yml
+
+Naming/FileName:
+  Exclude:
+    - lib/tenios-api.rb

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tenios-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    tenios-api (0.1.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)
+    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)
+    parallel (1.13.0)
+    parser (2.6.0.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    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
+  rake
+  rspec
+  tenios-api!
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pedro Chambino
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# Tenios API Client ☎️
+
+Get Call Detail Records (CDRs) from [Tenios API].
+
+[Tenios API]: https://www.tenios.de/en/doc/api-cdr-request
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tenios-api'
+```
+
+## Usage
+
+```ruby
+require 'tenios-api'
+
+client = Tenios::API::Client.new(access_key: ENV['TENIOS_ACCESS_KEY'])
+
+client.cdrs(Time.new(2019, 2, 1)..Time.new(2019, 2, 2))
+# returns lazy Enumerator with the records
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/carwow/tenios-api-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tenios/api/client.rb

@@ -0,0 +1,64 @@
+require 'json'
+require 'faraday'
+require 'faraday_middleware'
+
+module Tenios
+  module API
+    class Client
+      def initialize(access_key:)
+        @access_key = access_key
+      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
+
+          c.adapter Faraday.default_adapter
+        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
+
+      private
+
+      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)'
+        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
+    end
+  end
+end

data/lib/tenios/api/version.rb

@@ -0,0 +1,5 @@
+module Tenios
+  module API
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/tenios/api.rb

@@ -0,0 +1,6 @@
+module Tenios
+  module API
+    autoload :Version, 'tenios/api/version'
+    autoload :Client, 'tenios/api/client'
+  end
+end

data/lib/tenios-api.rb

@@ -0,0 +1 @@
+require 'tenios/api'

data/tenios-api.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require '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'
+
+  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.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.add_dependency 'faraday'
+  spec.add_dependency 'faraday_middleware'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'carwow_rubocop'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: tenios-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- carwow Developers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: carwow_rubocop
+  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
+    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: rspec
+  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'
+description: Get Call Detail Records (CDRs) from Tenios API.
+email:
+- developers@carwow.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tenios-api.rb
+- lib/tenios/api.rb
+- lib/tenios/api/client.rb
+- lib/tenios/api/version.rb
+- tenios-api.gemspec
+homepage: https://github.com/carwow/tenios-api-ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Tenios API Client ☎️
+test_files: []