nssql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 29284906429e7ba1a341a0da360a5ba9e654bff1a0f09f4e27497ce0ca5bc297
+  data.tar.gz: 8523783c568694450af7c5c88d5172a3f14aca79b9f841994dca151a2e6558cd
+SHA512:
+  metadata.gz: 59cebec72fa7f9dd1ab48d015a3ab98bd1fe79bc6bd0f8d201922fb2903599c13da6deb8dbce2dd7418c261de29066052da4b6940876719f922592649ca54241
+  data.tar.gz: 58eb26419ded890eea6f689264958d8abb9c84f78007e1f809ca49e9a1c5269f98bc8f4fbf4d2ec75a1663f55bbfa3770eedbee16d245dabb5d13e03891f47fb

data/.codeclimate.yml

@@ -0,0 +1,21 @@
+# Please read:
+# - https://docs.codeclimate.com/docs/default-analysis-configuration
+# - https://docs.codeclimate.com/docs/advanced-configuration
+#
+version: "2"
+checks:
+  file-lines:
+    enabled: false
+  method-lines:
+    enabled: false
+plugins:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby:
+    exclude_patterns:
+      - test/
+  rubocop:
+    enabled: true
+    channel: rubocop-0-66

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,27 @@
+# This is the modified configuration used to check the source code.
+
+AllCops:
+  TargetRubyVersion: 2.5 # Update once CC has support for > 2.5
+
+# === OVERRIDE ===
+#
+# - https://rubocop.readthedocs.io/en/latest/cops_metrics/#metricslinelength
+#
+Metrics/LineLength:
+  Max: 120
+
+# === OVERRIDE ===
+#
+# - https://rubocop.readthedocs.io/en/latest/cops_metrics/#metricsmethodlength
+#
+Metrics/MethodLength:
+  Max: 15
+
+# === DISABLE
+#
+# - https://rubocop.readthedocs.io/en/latest/cops_style/#styletrivialaccessors
+#
+# Why? Faulty corrections.
+#
+Style/TrivialAccessors:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+nssql

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.2

data/.travis.yml

@@ -0,0 +1,20 @@
+---
+env:
+  global:
+    secure: ZqVkW/Zi5JIy3kbnWGtDe82AnZHxDEccSc/w64JbsavXt03Whmqxp5BUiHXUvp0Q203w6sK2vsopJ0itTim3jB2ad5NplkzdlgH6Due8FS1fMKbLlE6TUmRvifl1ACinbpsxGRmPqAtZkbeHZrq6VlmZosTYX8LHMyxVut7SC87AhEizV4mo1+gKxnw2jILUn3+NRD0gjR+l3QNChlG2Z1hMUwxaWO3rmgSmwPqcHIjJuF7lQC/4h1FHDhSKclXADbpxDl5efpAxIiXWXEoTbrVB2XaX6Sn9I07PEo3BWqza5KoY9Ir+6gB+bV/W8uIeDbiZbidZffXxojOwD3lbKWtRkmR8FxFWbNvjO8D+qG1dMCUHDyGY3w1tIu9lpqhDX2X2C9Hn1ArDi1ZHc6FwysTwfy72o95StdYhWdmckQLbpe8+D9p3r3n1wJpd5hm9NKwSOjbokQHn2FzdNVZg1FNpg6LxS/ILQEcDQ9l5yvcY/ll9rXS2J8NT5WgsxXoK6trnZP+k/AOgMvLuC9Tg3WLxPVb/lJ7/fkMCiZ49jWYYap89Ig7wIWTeuxGq2yLyvUSH/dpEtg+LhsCOQBugjFQWRWHrLqPh3ggu6nNNie+LzwIb6ofuoGT9FTkn6/5TwhwG32OX1QMrt1GWQAk+oUu+D674zbByXVLl1CoyT0c=
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+  - 2.5.3
+  - 2.6.2
+before_install: gem install bundler -v 1.17.3
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2019-04-08)
+
+  - Initial release

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 love.ottosson@apoex.se. 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,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nssql.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Love Ottosson
+
+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,103 @@
+# NSSQL
+
+[![Build Status](https://travis-ci.org/apoex/nssql.svg?branch=master)](https://travis-ci.org/apoex/nssql)
+[![Maintainability](https://api.codeclimate.com/v1/badges/0bc97f0e7fef36bcf922/maintainability)](https://codeclimate.com/github/apoex/nssql/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/0bc97f0e7fef36bcf922/test_coverage)](https://codeclimate.com/github/apoex/nssql/test_coverage)
+
+NSSQL allows you to query directly against NetSuite through an ODBC connection. Define your tables, primary keys and columns and query away!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nssql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nssql
+
+## Usage
+
+Follow the steps below to start using NSSQL.
+
+### Settings
+
+```ruby
+NSSQL::Settings.configure do |config|
+  config.user     = 'USER'
+  config.password = 'PASSWORD'
+end
+```
+
+### Table
+
+```ruby
+class TestTable < NSSQL::Table
+  table_name   'test_table'
+  primary_keys 'id', 'line_id'
+  columns      'id', 'line_id', 'name'
+end
+```
+
+### Table
+
+`TestTable.select_columns_query` will generate:
+
+```SQL
+SELECT
+  id,line_id,name
+FROM
+  test_table
+ORDER BY
+  id
+```
+
+We can pass options, like `TestTable.select_columns_query(where: 'id > 500')` and this will generate:
+
+```SQL
+SELECT
+  id,line_id,name
+FROM
+  test_table
+WHERE id > 500
+ORDER BY
+  id
+```
+
+### Other selects
+
+Select to file
+
+```ruby
+NSSQL.select_to_file('SELECT 1+1')
+```
+
+Select array
+
+```ruby
+NSSQL.select_array('SELECT 1+1')
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/apoex/nssql. 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 Nssql project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/apoex/nssql/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'nssql'
+
+# 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/nssql/settings.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module NSSQL
+  # Simple class for configuration of credentials.
+  class Settings
+    include Singleton
+
+    SETTINGS = %i[
+      user
+      password
+    ].freeze
+
+    attr_accessor(*SETTINGS)
+
+    class << self
+      SETTINGS.each do |setting|
+        define_method(setting) do
+          instance.public_send(setting)
+        end
+      end
+
+      def configure
+        yield instance
+      end
+    end
+  end
+end

data/lib/nssql/table.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module NSSQL
+  # Base class for representing NetSuite tables.
+  # Table name, primary keys and wanted columns are expected to be defined.
+  class Table
+    class << self
+      def select_columns_query(where: nil)
+        where_statement = "WHERE #{where}" if where
+
+        <<~SQL
+          SELECT
+            #{@columns.join(',')}
+          FROM
+            #{@table_name}
+          #{where_statement if where}
+          ORDER BY
+            #{@primary_keys.first}
+        SQL
+      end
+
+      def table_name(table_name)
+        @table_name = table_name
+      end
+
+      def primary_keys(*primary_keys)
+        @primary_keys = primary_keys
+      end
+
+      def columns(*columns)
+        @columns = columns
+      end
+    end
+  end
+end

data/lib/nssql/version.rb

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

data/lib/nssql.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'nssql/version'
+require 'nssql/settings'
+require 'nssql/table'
+
+require 'odbc_utf8'
+require 'tempfile'
+
+# NSSQL module.
+#
+module NSSQL
+  class Error < StandardError; end
+
+  class << self
+    def select_array(query)
+      execute(query, &:fetch_all)
+    end
+
+    def select_to_file(query)
+      query = one_line_query(query)
+
+      isql_command = "isql -v Netsuite #{NSSQL::Settings.user} '#{NSSQL::Settings.password}' -b -q -d,"
+      iconv_command = 'iconv -f iso-8859-1 -t utf-8'
+
+      Tempfile.new.tap do |file|
+        system_call("echo \"#{query}\" | #{isql_command} | #{iconv_command} > #{file.path}")
+      end
+    end
+
+    def configure
+      NSSQL::Settings.configure
+    end
+
+    private
+
+    def execute(query)
+      netsuite_connection.prepare(query).execute.tap do |result|
+        yield result if block_given?
+
+        result.drop
+      end
+    end
+
+    def system_call(command)
+      `#{command}`
+    end
+
+    def one_line_query(query)
+      query.tr("\n", ' ').gsub(/\s+/, ' ').strip
+    end
+
+    def netsuite_connection
+      ODBC.connect('NetSuite', NSSQL::Settings.user, NSSQL::Settings.password)
+    end
+  end
+end

data/nssql.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nssql/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nssql'
+  spec.version       = NSSQL::VERSION
+  spec.authors       = ['Love Ottosson']
+  spec.email         = ['love.ottosson@apoex.se']
+
+  spec.summary       = 'Lightweight gem for fetching data from NetSuite with SQL.'
+  spec.description   = 'Represent NetSuite tables as you want and fetch only the needed data.'
+  spec.homepage      = 'https://github.com/apoex/nssql'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/apoex/nssql'
+    spec.metadata['changelog_uri'] = 'https://github.com/apoex/nssql/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'ruby-odbc', '~> 0.99997'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '>= 0.60.0'
+  spec.add_development_dependency 'simplecov', '>= 0.16.0'
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: nssql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Love Ottosson
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-odbc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.99997'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.99997'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+description: Represent NetSuite tables as you want and fetch only the needed data.
+email:
+- love.ottosson@apoex.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nssql.rb
+- lib/nssql/settings.rb
+- lib/nssql/table.rb
+- lib/nssql/version.rb
+- nssql.gemspec
+homepage: https://github.com/apoex/nssql
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/apoex/nssql
+  source_code_uri: https://github.com/apoex/nssql
+  changelog_uri: https://github.com/apoex/nssql/blob/master/CHANGELOG.md
+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.3
+signing_key: 
+specification_version: 4
+summary: Lightweight gem for fetching data from NetSuite with SQL.
+test_files: []