rRubocop and configuration (#2)

* rubocop

* change directory structure

* string literals

* configuration specs

Author: inderps

.rubocop.yml

@@ -0,0 +1,112 @@
+require:
+  - rubocop-rspec
+# Explanations of all possible options:
+#   https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  Exclude:
+    - 'pkg/**/*'
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+
+Metrics/MethodLength:
+  Max: 25
+
+Layout/LineLength:
+  Max: 160
+
+# Details:
+#   http://c2.com/cgi/wiki?AbcMetric
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be a Fixnum or
+  # a Float.
+  Max: 20
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Metrics/ClassLength:
+  Max: 120
+
+# TODO: enable this when Ruby 3.0 is out.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Style/NumericPredicate:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Gemspec/OrderedDependencies:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+RSpec/FilePath:
+  Enabled: true
+  IgnoreMethods: true
+
+Style/Documentation:
+  Enabled: false

Gemfile

@@ -1,7 +1,12 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cirro-ruby-client.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+
+group :development do
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec'
+end

Gemfile.lock

@@ -6,8 +6,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     diff-lcs (1.4.4)
+    parallel (1.19.2)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.8.1)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -21,6 +28,21 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    rubocop (0.92.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.5.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    rubocop-rspec (1.43.2)
+      rubocop (~> 0.87)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -29,6 +51,8 @@ DEPENDENCIES
   cirro-ruby-client!
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop
+  rubocop-rspec
 
 BUNDLED WITH
    2.1.4

Rakefile

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

bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "cirro_i_o/client"
+require 'bundler/setup'
+require 'cirro_io/client'
 
 # 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.
@@ -10,5 +10,5 @@ require "cirro_i_o/client"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

cirro-ruby-client.gemspec

@@ -1,27 +1,27 @@
-require_relative 'lib/cirro_i_o/client/version'
+require_relative 'lib/cirro_io/client/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "cirro-ruby-client"
+  spec.name          = 'cirro-ruby-client'
   spec.version       = CirroIO::Client::VERSION
-  spec.authors       = ["Cirro Dev Team"]
-  spec.email         = ["[email protected]"]
+  spec.authors       = ['Cirro Dev Team']
+  spec.email         = ['[email protected]']
 
-  spec.summary       = "Ruby client library for Cirro API"
-  spec.description   = "Simple wrapper for Cirro API"
-  spec.homepage      = "https://cirro.io/api-docs/v1#cirro-api-documentation"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.summary       = 'Ruby client library for Cirro API'
+  spec.description   = 'Simple wrapper for Cirro API'
+  spec.homepage      = 'https://cirro.io/api-docs/v1#cirro-api-documentation'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/test-IO/cirro-ruby-client"
-  spec.metadata["changelog_uri"] = "https://github.com/test-IO/cirro-ruby-client/CHANGELOG.md"
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/test-IO/cirro-ruby-client'
+  spec.metadata['changelog_uri'] = 'https://github.com/test-IO/cirro-ruby-client/CHANGELOG.md'
 
   # 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('..', __FILE__)) do
+  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.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 end

lib/cirro_i_o/client.rb renamed to lib/cirro_io/client.rb

@@ -1,4 +1,4 @@
-require "cirro_i_o/client/version"
+require 'cirro_io/client/version'
 
 module CirroIO
   module Client

lib/cirro_io/client/configuration.rb

@@ -0,0 +1,19 @@
+module CirroIO
+  module Client
+    class Configuration
+      def app_id(value = nil)
+        @app_id = value unless value.nil?
+        raise 'app_id must be defined' unless defined?(@app_id)
+
+        @app_id
+      end
+
+      def private_key_path(value = nil)
+        @private_key_path = value unless value.nil?
+        raise 'private_key_path must be defined' unless defined?(@private_key_path)
+
+        @private_key_path
+      end
+    end
+  end
+end

lib/cirro_i_o/client/version.rb renamed to lib/cirro_io/client/version.rb

@@ -1,5 +1,5 @@
 module CirroIO
   module Client
-    VERSION = "0.1.0"
+    VERSION = '0.1.0'.freeze
   end
 end

spec/cirro_io/client/configuration_spec.rb

@@ -0,0 +1,25 @@
+require 'cirro_io/client/configuration'
+
+RSpec.describe CirroIO::Client::Configuration do
+  let(:configuration) { described_class.new }
+
+  it 'assigns app_id' do
+    configuration.app_id '12345'
+
+    expect(configuration.app_id).to eq('12345')
+  end
+
+  it 'raise exception if app_id is not set' do
+    expect { configuration.app_id }.to raise_error('app_id must be defined')
+  end
+
+  it 'assigns private_key_path' do
+    configuration.private_key_path './storage/cirro.pem'
+
+    expect(configuration.private_key_path).to eq('./storage/cirro.pem')
+  end
+
+  it 'raise exception if private_key_path is not set' do
+    expect { configuration.private_key_path }.to raise_error('private_key_path must be defined')
+  end
+end