td_tip 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6202e736e2806b13bbe320c9a7b43d52fd70d7c
-  data.tar.gz: 0a0d8e6f5e8ba6e570856b28bcb11eeb5eb1b001
+  metadata.gz: dcb4ecc27a9584d91fe993eac68c8efbe065f102
+  data.tar.gz: d7434cd3c289cb43207969b4ed3b40c33aad6cbf
 SHA512:
-  metadata.gz: dfadc8f83b7458d2d8145790845c9eaa12638144338589ae4b69dcec62459719479ac2a0e295fe5c1ef651860a2efc710e825896630c3f686f559c48b4ac5abc
-  data.tar.gz: 0743ee2619f366acd3da49b8e41ddc1bf9ae78ec92ab954a3d063c1b3e8d4df04f5be3ef2b1677c971abb7a8313ae25287bb9e090ad46639793412192440f0ef
+  metadata.gz: a45f5d132b756d79e1de561fa707c1f7d47f4ad4fbb1d546b946660d4cc49896f4e85c5c5fd8da043c15cce33151b9e594a4e2f1bd84292127638edf85f4300a
+  data.tar.gz: 0bee6a80beb4aac1ce25418fefebad8fbfeafa8666460ad3fbdd81de2ae4a1dba977853d5fce006307aa143b436286e68a5d476fa8105a7b391fa22a02155e7d

data/.codeclimate.yml

@@ -0,0 +1,11 @@
+---
+engines:
+  fixme:
+    enabled: false
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- spec/**/*

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Style/FileName:
+  Enabled: false

data/README.md

@@ -1,8 +1,12 @@
 # TdTip
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/td_tip`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/td_tip.svg)](https://badge.fury.io/rb/td_tip)
+[![Build Status](https://travis-ci.org/wspyra/td_tip.svg)](https://travis-ci.org/wspyra/td_tip)
+[![Coverage Status](https://coveralls.io/repos/wspyra/td_tip/badge.svg?branch=master&service=github)](https://coveralls.io/github/wspyra/td_tip?branch=master)
+[![Dependency Status](https://gemnasium.com/wspyra/td_tip.svg)](https://gemnasium.com/wspyra/td_tip)
+[![Code Climate](https://codeclimate.com/github/wspyra/td_tip/badges/gpa.svg)](https://codeclimate.com/github/wspyra/td_tip)
 
-TODO: Delete this and the text above, and describe your gem
+T+D Code challenge solution
 
 ## Installation
 
@@ -22,18 +26,13 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Commands:
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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/[USERNAME]/td_tip. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+    $ calculate-tip
+    
+    $ calculate-tip --amount AMOUNT --tip NUMBER
 
+    $ calculate-tip help calculate
 
 ## License
 

data/lib/td_tip/cli.rb

@@ -11,12 +11,13 @@ module TdTip
 
     attr_reader :cli_options, :parameters, :response
 
+    # Main/default action
     def calculate
       set_cli_options
       set_parameters
 
       if parameters.valid?
-        @response = TdTip::Models::Response.new(parameters).get
+        set_response
         display_response
       else
         display_validation_errors parameters
@@ -25,16 +26,24 @@ module TdTip
 
     private
 
+    # Set options from command line or ask user
     def set_cli_options
       @cli_options = options.dup
       @cli_options[:amount] ||= ask('# Please provide amount:')
       @cli_options[:tip] ||= ask('# Please provide tip (%):')
     end
 
+    # Set parameters from options
     def set_parameters
       @parameters = TdTip::Models::Parameters.new cli_options
     end
 
+    # Set response using parameters
+    def set_response
+      @response = TdTip::Models::Response.new(parameters).get
+    end
+
+    # Print response on screen
     def display_response
       if response.valid?
         say "# Total amount with tip: #{response.amount_with_tip}" \
@@ -45,6 +54,7 @@ module TdTip
       end
     end
 
+    # Print validation messages
     def display_validation_errors(obj)
       obj.errors.messages.each do |field, messages|
         say "# #{field.capitalize}: #{messages.join ', '}\n"

data/lib/td_tip/models/parameters.rb

@@ -17,12 +17,14 @@ module TdTip
         parse_amount options[:amount]
       end
 
+      # Returns parameters for Web Service
       def to_params
         { amount: amount, tip: tip }
       end
 
       protected
 
+      # Parses raw amount into final amount and currency
       def parse_amount(amount_raw)
         matches = TdTip::AMOUNT_CURRENCY_REGEXP.match amount_raw
         return unless matches

data/lib/td_tip/models/response.rb

@@ -2,7 +2,7 @@ require 'httparty'
 
 module TdTip
   module Models
-    # Response
+    # Response - performs request and handle response
     class Response
       include ActiveModel::Validations
       include HTTParty
@@ -21,6 +21,7 @@ module TdTip
         @parameters = parameters
       end
 
+      # Performs request and handle response
       def get
         result = parse_and_symbolize_json
         @amount_with_tip = result[:amount_with_tip]
@@ -32,14 +33,19 @@ module TdTip
 
       private
 
+      # Adds additional validation
       def other_errors
         errors.add(:error, error) unless error.blank?
       end
 
+      # Process request response
       def parse_and_symbolize_json
-        with_error_handling { JSON.parse(calculate_request.body).symbolize_keys! }
+        with_error_handling do
+          JSON.parse(calculate_request.body).symbolize_keys!
+        end
       end
 
+      # Performs post request to Web Service
       def calculate_request
         self.class.post WS_METHOD,
                         query: parameters.to_params,
@@ -48,7 +54,7 @@ module TdTip
 
       def with_error_handling
         yield
-      rescue => e
+      rescue HTTParty::Error, JSON::ParserError => e
         { error: e.message }
       end
     end

data/lib/td_tip/version.rb

@@ -1,4 +1,4 @@
 # Main gem's module
 module TdTip
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/td_tip.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.4'
-  spec.add_development_dependency 'coveralls', '~> 0.8.10'
+  spec.add_development_dependency 'coveralls', '~> 0.8.9'
   spec.add_development_dependency 'rubocop', '~> 0.35.1'
 
   spec.add_dependency 'thor', '~> 0.19.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: td_tip
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Wiesław Spyra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2015-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.10
+        version: 0.8.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.10
+        version: 0.8.9
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -130,9 +130,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt