taxbear 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fb8147306789ac6efa1d0823fc9e4567c93ff08
-  data.tar.gz: 0163982a788b881c63bd9a9ba74b5d4d32be13a6
+  metadata.gz: ee7df243ec9b37ad77afa11cae811c5d8b59bf0a
+  data.tar.gz: 553a58b8a16626dc983fc7047de87d923c1964dc
 SHA512:
-  metadata.gz: 4aa79d68dcd0cb329f44b16d1077cea9bc51b8e71c7954f3b48c3ecfddf7f0cfec53e61c76b7e9f2a1b6e4d22be5808efbebc820e02bf77b9f593e52db5ccfeb
-  data.tar.gz: 1325356af9f596d784a206b2d8a24a10ce4dc66acb54ee19aba4d2e731c009f2dabe2c75550606c398888856badf8c2451d868795b0de13551c87c3c771da852
+  metadata.gz: 01f20233998f3540f4e1c7de846848b52d22f4ea26df7f74e8e25b0ca0ce3b4ba4fce48f063290a55c4de7b5ad4aaca04822f382828415814ca4b5e2428951c2
+  data.tar.gz: 4e08d0850ebfd51d3022908e5dadace182de29c77b4db93cf4e43e0c6a2c0da8cf17fbb68f90b261f16df91b2f8c6a7bb76b49b13e45e30d24484510d424f490

data/.travis.yml

@@ -2,3 +2,6 @@ language: ruby
 rvm:
   - 2.3.0
 before_install: gem install bundler -v 1.11.2
+addons:
+  code_climate:
+    repo_token: 35170382ac79bbc14ea9cd8c1d41655cd7fb2eefd408eea597e082a247c03f21

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.3 (2016-10-18)
+- Move login to a separate command.
+- Validate token provided against TaxJar API.
+
 ## 0.1.2 (2016-10-18)
 - Improve CLI help.
 

data/README.md

@@ -1,14 +1,26 @@
 # Taxbear
 
 [![Gem Version](https://badge.fury.io/rb/taxbear.svg)](https://badge.fury.io/rb/taxbear)
+[![Build Status](https://travis-ci.org/jcypret/taxbear.svg?branch=master)](https://travis-ci.org/jcypret/taxbear)
+[![Code Climate](https://codeclimate.com/github/jcypret/taxbear/badges/gpa.svg)](https://codeclimate.com/github/jcypret/taxbear)
+[![Test Coverage](https://codeclimate.com/github/jcypret/taxbear/badges/coverage.svg)](https://codeclimate.com/github/jcypret/taxbear/coverage)
 
 ## Installation
 
-    $ gem install taxbear
+```bash
+$ gem install taxbear
+```
 
 ## Usage
 
-Lookup sales tax rates for a zip code:
+(1) Set your TaxJar API token:
+
+```bash
+$ taxbear login
+#=> What is your TaxJar API token?
+```
+
+(2) Lookup sales tax rates for a zip code:
 
 ```bash
 $ taxbear zip 72034

data/lib/taxbear.rb

@@ -1,9 +1,9 @@
 require "taxbear/cli"
+require "taxbear/config"
 require "taxbear/exceptions"
 require "taxbear/table_builder"
 require "taxbear/taxjar"
 require "taxbear/version"
 
 module Taxbear
-  CONFIG_FILE = ENV["HOME"] + "/.taxbear"
 end

data/lib/taxbear/cli.rb

@@ -2,27 +2,52 @@ require "thor"
 
 module Taxbear
   class CLI < Thor
+    desc "login", "Set API key used to authenticate with TaxJar"
+    def login
+      valid_token = false
+      while !valid_token
+        token = ask("What is your TaxJar API token?")
+        valid_token = Taxjar.validate_token(token)
+        say_nope if !valid_token
+      end
+      Config.save_token(token)
+      print_success "Success! You are now ready to access the TaxJar API."
+    end
+
     desc "zip [ZIPCODE]", "Display sales tax rates for specified zip code"
     def zip(zipcode)
-      ensure_api_key_is_available
       rates = Taxjar.get_rates_by_zipcode(zipcode)
       TableBuilder.print_rates_for_zipcode(rates, zipcode)
-    rescue TaxjarError => e
+    rescue => e
       print_error(e.message)
     end
 
     private
 
-    def ensure_api_key_is_available
-      unless File.exists?(CONFIG_FILE)
-        token = ask("What is your TaxJar API token?")
-        File.write(CONFIG_FILE, token)
-      end
-    end
-
     def print_error(error)
       error_message = "✘ #{error}"
       puts set_color(error_message, :red)
     end
+
+    def print_success(message)
+      success_message = "✔︎ #{message}"
+      puts set_color(success_message, :green)
+    end
+
+    def say_nope
+      print_error(random_no)
+    end
+
+    def random_no
+      [
+        "Nope, that's not correct.",
+        "Sorry, not quite right.",
+        "Maybe you should check the website? https://app.taxjar.com/smartcalcs",
+        "A for effort… but no.",
+        "I'll give you a hint, it's a bunch of random unguessable letters/numbers.",
+        "Good try, but unfortunately wrong.",
+        "Hmm… that doesn't seem to be working. Maybe something different?"
+      ].sample
+    end
   end
 end

data/lib/taxbear/config.rb

@@ -0,0 +1,32 @@
+module Taxbear
+  class Config
+    # This class manages the configuration file stored on the user's computer.
+
+    class << self
+      # Checks whether the Taxbear config file exists on the users computer.
+      #
+      # @return [Boolean] whether the config file exists
+      def exists?
+        File.exist?(config_file)
+      end
+
+      # Returns the TaxJar API token loaded from the users config file.
+      #
+      # @return [String] the TaxJar API token
+      def get_token
+        File.read(config_file)
+      end
+
+      # Saves the token to a .taxbear config file in the users home directory.
+      def save_token(token)
+        File.write(config_file, token)
+      end
+
+      private
+
+      def config_file
+        File.join(Dir.home, "/.taxbear")
+      end
+    end
+  end
+end

data/lib/taxbear/exceptions.rb

@@ -1,4 +1,4 @@
 module Taxbear
-  class TaxjarError < StandardError
-  end
+  class TaxjarError < StandardError; end
+  class TaxjarUnauthorized < StandardError; end
 end

data/lib/taxbear/table_builder.rb

@@ -10,13 +10,16 @@ module Taxbear
       # @param rates [Hash] the rates
       # @return [nil] returns nothing, prints to STDOUT
       def print_rates_for_zipcode(rates, zipcode)
-        puts ""
-        puts Terminal::Table.new(
+        output = ""
+        output << "\n"
+        output << Terminal::Table.new(
           title: "Sales Tax Rates for #{zipcode}",
           headings: align_each_cell_center(get_header_rows(rates)),
           rows: [align_each_cell_center(format_rates(rates))]
-        )
-        puts ""
+        ).to_s
+        output << "\n\n"
+
+        puts output
       end
 
       private

data/lib/taxbear/taxjar.rb

@@ -14,7 +14,8 @@ module Taxbear
       # @param zipcode [Integer] the zip code
       # @return [Hash] the rates returned by API
       def get_rates_by_zipcode(zipcode)
-        response = get("/rates/#{zipcode}", {headers: headers})
+        require_api_key()
+        response = get("/rates/#{zipcode}", {headers: auth_header})
 
         if response.success?
           response.fetch("rate")
@@ -23,14 +24,26 @@ module Taxbear
         end
       end
 
+      # Takes a tokens and returns whether the token is valid.
+      #
+      # @param token [String] the token
+      # @return [Boolean] whether token is valid
+      def validate_token(token)
+        get("/categories", headers: auth_header(token)).success?
+      end
+
       private
 
-      def headers
-        {"Authorization" => "Token token=#{api_token}"}
+      def require_api_key
+        raise_unauthorized unless Config.exists?
+      end
+
+      def raise_unauthorized
+        raise TaxjarUnauthorized, "You must have a TaxJar API key set to access rates. Use `taxbear login`."
       end
 
-      def api_token
-        File.read(CONFIG_FILE)
+      def auth_header(token = Config.get_token)
+        {"Authorization" => "Token token=#{token}"}
       end
     end
   end

data/lib/taxbear/version.rb

@@ -1,3 +1,3 @@
 module Taxbear
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/taxbear.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
+  spec.add_development_dependency "aruba", "~> 0.14.2"
+  spec.add_development_dependency "codeclimate-test-reporter"
 
   spec.add_dependency "thor", "~> 0.19"
   spec.add_dependency "httparty", "~> 0.14"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taxbear
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Justin Cypret
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +157,7 @@ files:
 - exe/taxbear
 - lib/taxbear.rb
 - lib/taxbear/cli.rb
+- lib/taxbear/config.rb
 - lib/taxbear/exceptions.rb
 - lib/taxbear/table_builder.rb
 - lib/taxbear/taxjar.rb