subsurface 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1465695dfb219a8e4cc1c32a3d71ecf8d5329b7cb19c9f0d29758e472a882eaa
+  data.tar.gz: 2680a772f23a8dcb8394ecf86a795c1a270d27affab45a118125c45cddb0795a
+SHA512:
+  metadata.gz: a4c57df9cbcb7f7e0addd118fffcee7f26dc79e43f76b0a9b1d697d8a584c2ef2943d8dd9495d7296277563df1f24c84ed5355954af80f7b47ba8c8b5043d206
+  data.tar.gz: 38d909ed68fd1c609bf5a3e91c8cf78b29db50d5345d626e571a6a21e35533cf7f4bb9e84de7e08ce94a4f4b0a7a4168a0098ea6b981cd00f9fd06891639a53f

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+subsurface

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.1

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at shrikant.patnaik@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in subsurface.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    subsurface (0.1.0)
+      nokogiri (~> 1.6, >= 1.6.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  subsurface!
+
+BUNDLED WITH
+   1.16.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Shrikant Patnaik
+
+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,36 @@
+# Subsurface
+Simple Gem to read Subsurface dive logs file
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'subsurface'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install subsurface
+
+## Usage
+
+`dives = Subsurface::Reader.read(file)`
+
+where file is an instance of `Nokogiri::XML`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shrikantpatnaik/subsurface. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Subsurface project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/subsurface/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "subsurface"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/subsurface.rb

@@ -0,0 +1,176 @@
+# frozen_string_literal: true
+
+require 'subsurface/version'
+require 'subsurface/extra_data'
+require 'subsurface/sample'
+require 'subsurface/computer_data'
+require 'subsurface/dive'
+# rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/ClassLength
+# main reader class
+module Subsurface
+  # Reader is the main class that reads the xml data
+  class Reader
+    def self.read(data)
+      dives = []
+      data.xpath('//dive').each do |dive|
+        computer_data = []
+        dive.xpath('divecomputer').each do |computer|
+          extra_datas = []
+          computer.xpath('extradata').each do |ed|
+            extra_datas.push(
+              ExtraData.new(
+                get_attribute_value(ed, nil, 'key'),
+                get_attribute_value(ed, nil, 'value')
+              )
+            )
+          end
+          samples = []
+          computer.xpath('sample').each do |sample|
+            samples.push(create_sample(sample))
+          end
+          computer_data.push(
+            create_computer_data(computer, extra_datas, samples)
+          )
+        end
+        dives.push(create_dive(dive, computer_data))
+      end
+      dives
+    end
+
+    class << self
+      private
+
+      def get_attribute_value(parent, xpath, attribute)
+        val = if xpath
+                if parent.xpath(xpath).empty?
+                  nil
+                else
+                  parent.xpath(xpath).attribute(attribute)
+                end
+              else
+                parent.attribute(attribute)
+              end
+        val&.value
+      end
+
+      def create_dive(dive_xpath, computer_data)
+        Dive.new(
+          get_attribute_value(dive_xpath, nil, 'number').to_i,
+          get_attribute_value(dive_xpath, nil, 'date'),
+          get_attribute_value(dive_xpath, nil, 'time'),
+          duration_in_seconds(
+            strip_minutes(get_attribute_value(dive_xpath, nil, 'duration'))
+          ),
+          strip_percent(
+            get_attribute_value(dive_xpath, 'cylinder', 'o2')
+          )&.to_f,
+          computer_data
+        )
+      end
+
+      def create_computer_data(computer_xpath, extra_datas, samples)
+        ComputerData.new(
+          get_attribute_value(computer_xpath, nil, 'model'),
+          get_attribute_value(computer_xpath, nil, 'deviceid'),
+          get_attribute_value(computer_xpath, nil, 'diveid'),
+          strip_meters(
+            get_attribute_value(computer_xpath, 'depth', 'max')
+          )&.to_f,
+          strip_meters(
+            get_attribute_value(computer_xpath, 'depth', 'mean')
+          )&.to_f,
+          strip_celsius(
+            get_attribute_value(computer_xpath, 'temperature', 'air')
+          )&.to_f,
+          strip_celsius(
+            get_attribute_value(computer_xpath, 'temperature', 'water')
+          )&.to_f,
+          strip_bar(
+            get_attribute_value(computer_xpath, 'surface', 'pressure')
+          )&.to_f,
+          strip_g_l(
+            get_attribute_value(computer_xpath, 'water', 'salinity')
+          )&.to_f,
+          extra_datas, samples
+        )
+      end
+
+      def create_sample(sample_xpath)
+        Sample.new(duration_in_seconds(
+                     strip_minutes(
+                       get_attribute_value(sample_xpath, nil, 'time')
+                     )
+                   ),
+                   strip_meters(
+                     get_attribute_value(sample_xpath, nil, 'depth')
+                   )&.to_f,
+                   strip_celsius(
+                     get_attribute_value(sample_xpath, nil, 'temp')
+                   )&.to_f,
+                   strip_bar(
+                     get_attribute_value(sample_xpath, nil, 'pressure')
+                   )&.to_f,
+                   duration_in_seconds(
+                     strip_minutes(
+                       get_attribute_value(sample_xpath, nil, 'ndl')
+                     )
+                   ),
+                   duration_in_seconds(
+                     strip_minutes(
+                       get_attribute_value(sample_xpath, nil, 'tts')
+                     )
+                   ),
+                   duration_in_seconds(
+                     strip_minutes(
+                       get_attribute_value(sample_xpath, nil, 'rbt')
+                     )
+                   ),
+                   strip_percent(
+                     get_attribute_value(sample_xpath, nil, 'cns')
+                   )&.to_f)
+      end
+
+      def strip_minutes(string)
+        strip_unit(string, 'min')
+      end
+
+      def strip_percent(string)
+        strip_unit(string, '%')
+      end
+
+      def strip_celsius(string)
+        strip_unit(string, 'C')
+      end
+
+      def strip_bar(string)
+        strip_unit(string, 'bar')
+      end
+
+      def strip_meters(string)
+        strip_unit(string, 'm')
+      end
+
+      def strip_g_l(string)
+        strip_unit(string, 'g/l')
+      end
+
+      def strip_unit(string, unit)
+        if string.nil?
+          nil
+        else
+          string.slice! unit
+          string.strip
+        end
+      end
+
+      def duration_in_seconds(string)
+        unless string.nil?
+          durations = string.split(':')
+          return (durations[0].strip.to_i * 60) + durations[1].strip.to_i
+        end
+        nil
+      end
+    end
+  end
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/ClassLength
+end

data/lib/subsurface/computer_data.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Subsurface
+  # noinspection RubyTooManyInstanceVariablesInspection
+  # Stores the computer data for each computer in the dive
+  class ComputerData
+    # TODO: Handle events
+    attr_reader :model, :device_id, :dive_id, :max_depth, :mean_depth,
+                :air_temp, :water_temp, :surface_pressure,
+                :salinity, :extra_datas, :samples
+    # rubocop:disable Metrics/ParameterLists, Metrics/MethodLength
+    # @param [String] model
+    # @param [String] device_id
+    # @param [String] dive_id
+    # @param [Integer] max_depth in meters
+    # @param [Integer] mean_depth in meters
+    # @param [Integer] air_temp in C
+    # @param [Integer] water_temp in C
+    # @param [Integer] surface_pressure in bar
+    # @param [Integer] salinity in g/l
+    # @param [ExtraData] extra_datas
+    # @param [Sample] samples
+    # @return [ComputerData]
+    def initialize(model, device_id, dive_id, max_depth, mean_depth, air_temp,
+                   water_temp, surface_pressure, salinity, extra_datas, samples)
+      @model = model
+      @device_id = device_id
+      @dive_id = dive_id
+      @max_depth = max_depth
+      @mean_depth = mean_depth
+      @air_temp = air_temp
+      @water_temp = water_temp
+      @surface_pressure = surface_pressure
+      @salinity = salinity
+      @extra_datas = extra_datas
+      @samples = samples
+    end
+    # rubocop:enable Metrics/ParameterLists, Metrics/MethodLength
+  end
+end

data/lib/subsurface/dive.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Dive is the model that contains all the information for each dive
+class Dive
+  attr_reader :number, :date, :time, :duration, :o2_percent, :computer_data
+  # rubocop:disable Metrics/ParameterLists
+  # @param [Integer] number
+  # @param [String] date
+  # @param [String] time
+  # @param [Integer] duration in seconds
+  # @param [Integer] o2_percent=
+  # @param [ComputerData] computer_data
+  # @return [Dive]
+  def initialize(number, date, time, duration, o2_percent, computer_data)
+    @number = number
+    @date = date
+    @time = time
+    @duration = duration
+    @o2_percent = o2_percent
+    @computer_data = computer_data
+  end
+  # rubocop:enable Metrics/ParameterLists
+end

data/lib/subsurface/extra_data.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Subsurface
+  # Stores extra data in key value pairs
+  class ExtraData
+    attr_reader :key, :value
+    # @param [String] key
+    # @param [String] value
+    def initialize(key, value)
+      @key = key
+      @value = value
+    end
+  end
+end

data/lib/subsurface/sample.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Subsurface
+  # TODO: Stops, o2sensors, set_point, heartbeat, bearing, in_deco
+  # Stores the data in each sample
+  class Sample
+    attr_reader :time, :depth, :temp, :pressure, :ndl, :tts, :rbt, :cns
+    # rubocop:disable Metrics/ParameterLists
+    # @param [String] time
+    # @param [Integer] depth
+    # @param [Integer] temp
+    # @param [Integer] pressure
+    # @param [Integer] ndl
+    # @param [Integer] tts
+    # @param [Integer] rbt
+    # @param [Integer] cns
+    # @return [Sample]
+    def initialize(time, depth, temp, pressure, ndl, tts, rbt, cns)
+      @time = time
+      @depth = depth
+      @temp = temp
+      @pressure = pressure
+      @ndl = ndl
+      @tts = tts
+      @rbt = rbt
+      @cns = cns
+    end
+    # rubocop:enable Metrics/ParameterLists
+  end
+end

data/lib/subsurface/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Subsurface
+  VERSION = '0.1.0'
+end

data/subsurface.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subsurface/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'subsurface'
+  spec.version       = Subsurface::VERSION
+  spec.authors       = ['Shrikant Patnaik']
+  spec.email         = ['shrikant.patnaik@gmail.com']
+
+  spec.summary       = 'Convert SSRF to Ruby models'
+  spec.description   = 'Easy way to use Subsurface exports in ruby'
+  spec.homepage      = 'https://github.com/shrikantpatnaik/subsurface'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been
+  # added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nokogiri', '~> 1.6', '>= 1.6.8'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: subsurface
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shrikant Patnaik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Easy way to use Subsurface exports in ruby
+email:
+- shrikant.patnaik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/subsurface.rb
+- lib/subsurface/computer_data.rb
+- lib/subsurface/dive.rb
+- lib/subsurface/extra_data.rb
+- lib/subsurface/sample.rb
+- lib/subsurface/version.rb
+- subsurface.gemspec
+homepage: https://github.com/shrikantpatnaik/subsurface
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Convert SSRF to Ruby models
+test_files: []