endpointer 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e705dec6f55d6ae9e87f60e415451ec35f1826d7
-  data.tar.gz: f99559081ebf4ff13bc782e5c4d3dbe13a0f7fc1
+  metadata.gz: a628ec40e0ebf2d37e81363bc14414499a71e2ca
+  data.tar.gz: 44ccbdca0c8c66cdbfc029c1a54ad7bbd05069e4
 SHA512:
-  metadata.gz: 231c82787a365665c0c322f0c4dd6c70a03c3a461db9771d98de63c37fa4b6c6f67ce6a90b10d580a59f88d19e8df4370b0a3c02336b27f54680f7c4ab85dffd
-  data.tar.gz: 2292181e7d9aaf294428cca8189d7ce6fae38a14ca37424b13d0a9842c929524530038d49c2dd230d92cb089cb9c58bd5cd035b2290210ae92cc95037a1d9b25
+  metadata.gz: a1faa71cf5ea0e0dcf5bd8684bb7af2ae940adee40c3a073579c3e3fcbd74915fb896b711d54a6c834b8a84b74c7ab77ff037e7acc3171e7bb8e13950307edad
+  data.tar.gz: 881bed74421da18ace219797cfafb0e359a88e010c3d4d7cbbcecb48180c2f30007f96baf34cdb058ba2a2338f6d6851bf08245224218ac1d19e06876351551a

data/.travis.yml

@@ -6,6 +6,7 @@ branches:
 rvm:
 - 2.4.0
 - 2.3.3
+- 2.2.6
 - jruby-9.1.6.0
 script:
 - bundle exec rake

data/README.md

@@ -6,7 +6,7 @@ Endpointer is a small gem that tries to act as a caching proxy between your dev
 
 ## Requirements
 
-* Ruby 2.2+ (Tests running against MRI 2.4.0, 2.3.3, and JRuby 9.1.6.0)
+* Ruby 2.2+ (Tests running against MRI 2.4.0, 2.3.3, 2.2.6, and JRuby 9.1.6.0)
 
 ## Installation
 
@@ -45,7 +45,19 @@ In order to use Endpointer you need to create a JSON configuration file with the
 
 You can then invoke endpointer by executing
 
-    $ endpointer [--invalidate] <path_to_json_config_file>
+    $ endpointer
+
+(Note: Endpointer by default looks for a file called `endpointer.json` in the current directory)
+
+A full list of endpointer commands can be seen by invoking `endpointer --help`
+```
+❯ endpointer --help
+Usage: endpointer [options]
+    -d, --cache-dir CACHE_DIR        Modifies the default cache directory [Default: TMP_DIR/endpointer_cache]
+    -i, --invalidate                 Invalidates the cache at startup
+    -c, --config CONFIG              Override the default resource config file path. [Default: ./endpointer.json]
+
+```
 
 Or, include it in a config.ru
 
@@ -54,7 +66,13 @@ Or, include it in a config.ru
 #config.ru
 require 'endpointer'
 
-run Endpointer.app(['--invalidate', '<path_to_json_file>'])
+Endpointer.configure do |config|
+  config.invalidate = false # Default
+  config.resource_config = File.read('./endpointer.json') # Default
+  config.cache_dir = File.join(Dir.tmpdir, 'endpointer_cache') # Default
+end
+
+run Endpointer.app
 ```
 
 Endpointer will attempt to return a cached resource, if one is found to match the request. Otherwise, a call to the real service will be performed and the response, if successful, persisted.
@@ -71,7 +89,7 @@ If the request is to be executed against the real service the headers defined in
 
 By default endpointer will use your operating system's temp directory to store its cache files `(TMP_DIR/endpointer_cache)`. In order to configure the cache path you need to pass the `--cache-dir=<path>` argument.
 
-    $ endpointer [--invalidate] [--cache-dir=/path/to/cache] <path_to_json_config_file>
+    $ endpointer -cache-dir=/path/to/cache
 
 You can provide the `--invalidate` flag to the command line to invalidate the cache. This empties the endpointer_cache directory.
 

data/bin/endpointer

@@ -2,10 +2,7 @@
 
 require "bundler/setup"
 require "endpointer"
+require "endpointer/argument_parser"
 
-begin
-  Endpointer.run ARGV
-rescue Endpointer::Errors::InvalidArgumentsError
-  STDERR.puts "Usage: endpointer [--invalidate] [--cache-dir=/path/to/cache] <path_to_json_config>.json"
-  exit 1
-end
+config = Endpointer::ArgumentParser.new.parse(ARGV)
+Endpointer.run config

data/endpointer.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
   spec.description   = %q{Allows you to define endpoints to serve via a small caching proxy}
   spec.homepage      = "https://github.com/zenonas/endpointer"
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.2.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = ["endpointer"]

data/examples/endpointer.json

@@ -0,0 +1,19 @@
+[
+  {
+    "id": "httpbinpost",
+    "method": "post",
+    "url": "http://httpbin.org/post",
+    "headers": {
+      "Authorization": "Bearer test",
+      "Content-Type": "application/json"
+    }
+  },
+  {
+    "id": "httpbinget",
+    "method": "get",
+    "url": "https://httpbin.org/get",
+    "headers": {
+      "Authorization": "Bearer test"
+    }
+  }
+]

data/lib/endpointer.rb

@@ -1,19 +1,30 @@
 require "endpointer/version"
-require "endpointer/argument_parser"
+require "endpointer/resource_parser"
 require "endpointer/app_creator"
 require "endpointer/errors/invalid_arguments_error"
+require 'endpointer/configuration'
 
 module Endpointer
+  class << self
+    def run(config)
+      @configuration = config
+      app.run!
+    end
 
-  def self.run(arguments)
-    app(arguments).run!
-  end
+    def app
+      Cacher.new(configuration.cache_dir).invalidate if configuration.invalidate
+      AppCreator.new.create(configuration)
+    end
+
+    def configure
+      yield(configuration) if block_given?
+      self
+    end
+
+    private
 
-  def self.app(arguments)
-    argument_parser = ArgumentParser.new(arguments)
-    raise Errors::InvalidArgumentsError unless argument_parser.valid?
-    options = argument_parser.parse_options
-    Cacher.new(options.cache_dir).invalidate if options.invalidate
-    AppCreator.new.create(argument_parser.parse_resources, options)
+    def configuration
+      @configuration ||= Configuration.new
+    end
   end
 end

data/lib/endpointer/app_creator.rb

@@ -5,10 +5,10 @@ require 'uri'
 module Endpointer
   class AppCreator
 
-    def create(resources, options)
-      resources.each do |resource|
+    def create(config)
+      resources(config).each do |resource|
         app.send(resource.method, path(resource.url)) do
-          executor_response = Endpointer::ResourceExecutor.new.perform(request, resource, options)
+          executor_response = Endpointer::ResourceExecutor.new.perform(request, resource, config)
           headers executor_response.headers
           executor_response.body
         end
@@ -25,5 +25,9 @@ module Endpointer
     def path(url)
       URI.parse(url).path
     end
+
+    def resources(config)
+      Endpointer::ResourceParser.new.parse(config.resource_config)
+    end
   end
 end

data/lib/endpointer/argument_parser.rb

@@ -1,64 +1,47 @@
 require 'endpointer/resource'
-require 'endpointer/options'
+require 'endpointer/configuration'
 require 'json'
 
 module Endpointer
   class ArgumentParser
 
-    VALID_OPTIONS = [
-      '--invalidate',
-      '--cache-dir='
-    ]
-
-    def initialize(arguments)
-      @arguments = arguments
-    end
-
-    def parse_resources
-      parse_config(config_file).map do |resource|
-        Resource.new(resource["id"], resource["method"].to_sym, resource["url"], resource["headers"])
+    def parse(arguments)
+      begin
+        opt_parser.parse(arguments)
+      rescue OptionParser::InvalidOption => e
+        abort "Error: #{e}"
       end
-    end
 
-    def parse_options
-      options = @arguments.select { |argument| option_argument?(argument)}
-      build_options_from(options)
-    end
-
-    def valid?
-      return false unless config_file
-      valid_arguments = VALID_OPTIONS + [config_file]
-      return false if @arguments.any? { |arg|
-        valid_arguments.none? { |valid_opt| arg.include?(valid_opt) }
-      }
-      true
+      configuration
     end
 
     private
 
-    def build_options_from(parsed_options)
-      invalidate = parsed_options.include?("--invalidate")
-      cache_dir_arg = parsed_options.find { |opt| opt.match(/^--cache-dir/) }
-      cache_dir = cache_dir_arg.split('=').last unless cache_dir_arg.nil?
-
-      Options.new(invalidate, cache_dir)
-    end
-
-    def config_file
-      @arguments.find { |argument| config_file?(argument) }
-    end
-
-    def parse_config(config_file)
-      JSON.parse(File.read(config_file))
-    end
-
-    def option_argument?(argument)
-      argument.match(/^--.*/)
+    def opt_parser
+      OptionParser.new do |parser|
+        parser.banner = "Usage: endpointer [options]"
+
+        parser.on("-d CACHE_DIR", "--cache-dir CACHE_DIR", "Modifies the default cache directory [Default: TMP_DIR/endpointer_cache]") do |cache_dir|
+          configuration.cache_dir = cache_dir if cache_dir
+        end
+
+        parser.on("-i", "--invalidate", "Invalidates the cache at startup") do
+          configuration.invalidate = true
+        end
+
+        parser.on("-c CONFIG", "--config CONFIG", "Override the default resource config file path. [Default: ./endpointer.json]") do |config|
+          begin
+            resource_config = File.read(config)
+            configuration.resource_config = resource_config
+          rescue Errno::ENOENT
+            abort "Error: Config file supplied does not exist"
+          end
+        end
+      end
     end
 
-    def config_file?(argument)
-      argument.match(/.json$/) || File.exist?(argument)
+    def configuration
+      @configuration ||= Endpointer::Configuration.new
     end
-
   end
 end

data/lib/endpointer/configuration.rb

@@ -0,0 +1,18 @@
+module Endpointer
+  class Configuration
+
+    attr_accessor :invalidate, :cache_dir, :resource_config
+
+    DEFAULT_CONFIG_PATH = './endpointer.json'
+
+    def initialize(invalidate = nil, cache_dir = nil)
+      @invalidate = invalidate || false
+      @cache_dir = cache_dir || File.join(Dir.tmpdir, "endpointer_cache")
+      begin
+        @resource_config = File.read(DEFAULT_CONFIG_PATH)
+      rescue Errno::ENOENT
+        @resource_config = nil
+      end
+    end
+  end
+end

data/lib/endpointer/resource_parser.rb

@@ -0,0 +1,23 @@
+require 'json'
+require 'endpointer/resource'
+
+module Endpointer
+  class ResourceParser
+    def parse(resource_config)
+      parse_config(resource_config).map do |resource|
+        Resource.new(resource["id"], resource["method"].to_sym, resource["url"], resource["headers"])
+      end
+    end
+
+    private
+
+    def parse_config(config)
+      abort("Error: No config file present") if config.nil?
+      begin
+        JSON.parse(config)
+      rescue JSON::ParserError
+        abort("Error: The resource config is invalid")
+      end
+    end
+  end
+end

data/lib/endpointer/version.rb

@@ -1,3 +1,3 @@
 module Endpointer
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endpointer
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Zen Kyprianou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -170,17 +170,18 @@ files:
 - bin/console
 - bin/endpointer
 - endpointer.gemspec
+- examples/endpointer.json
 - lib/endpointer.rb
 - lib/endpointer/app.rb
 - lib/endpointer/app_creator.rb
 - lib/endpointer/argument_parser.rb
 - lib/endpointer/cache_container.rb
 - lib/endpointer/cacher.rb
+- lib/endpointer/configuration.rb
 - lib/endpointer/errors/cached_item_not_found_error.rb
 - lib/endpointer/errors/invalid_arguments_error.rb
 - lib/endpointer/errors/invalid_cache_dir_error.rb
 - lib/endpointer/errors/performer_not_found_error.rb
-- lib/endpointer/options.rb
 - lib/endpointer/performer_factory.rb
 - lib/endpointer/performers.rb
 - lib/endpointer/performers/get.rb
@@ -188,6 +189,7 @@ files:
 - lib/endpointer/performers/post.rb
 - lib/endpointer/resource.rb
 - lib/endpointer/resource_executor.rb
+- lib/endpointer/resource_parser.rb
 - lib/endpointer/response.rb
 - lib/endpointer/response_presenter.rb
 - lib/endpointer/version.rb
@@ -203,7 +205,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/endpointer/options.rb

@@ -1,11 +0,0 @@
-module Endpointer
-  class Options
-
-    attr_accessor :invalidate, :cache_dir
-
-    def initialize(invalidate = nil, cache_dir = nil)
-      @invalidate = invalidate || false
-      @cache_dir = cache_dir || File.join(Dir.tmpdir, "endpointer_cache")
-    end
-  end
-end