endpointer 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 309e7c6adba9e6eec3ebcbfcbf40056036e044eb
-  data.tar.gz: bc55a47865df1fcf8b610d86478bb06f07f3a913
+  metadata.gz: bc331a3a040610cc6532a7a9ca8efb99a91076f7
+  data.tar.gz: 7a398693347e0bdfc2b737db2bab9b63b2236a0c
 SHA512:
-  metadata.gz: bacffc299387e41259df9c3ed29d6c4636ff98b91ae2c31d7c401cd215ac72d95b8b451956d37bd3b531ec44755e92f393536a3b2bc33a64a011e2420409b7a6
-  data.tar.gz: bdfcc59cdee9f13309c4992feff17fdc7e92a63d6cf8c8c28e5d4c4373b778b5e7664a1682ea8d133e7865c0a6618f2fa851850282e00594d51f963c2efca902
+  metadata.gz: 6b1ace4fe1e824dbadbcaa67b2a28d8b77b6cfe44ddf880eb3958f222e8c2efd5e9ca0103b1e8e44bf57d5dbad8681d719fcaa78819f7a5fcef95e806c72288f
+  data.tar.gz: bd145e7528efdf64b91bdf01f30071857e8bf1155c3b9ad55916bfecf02b7fd7ccb7ad7fc7be52810234095894afc9b1896c53d90da80e3572489b319fca47a0

data/README.md

@@ -2,11 +2,11 @@
 
 [![Gem Version](https://badge.fury.io/rb/endpointer.svg)](http://badge.fury.io/rb/endpointer) [![Build Status](https://travis-ci.org/zenonas/endpointer.svg?branch=master)](https://travis-ci.org/zenonas/endpointer) [![Code Climate](https://codeclimate.com/github/zenonas/endpointer/badges/gpa.svg)](https://codeclimate.com/github/zenonas/endpointer) [![Test Coverage](https://codeclimate.com/github/zenonas/endpointer/badges/coverage.svg)](https://codeclimate.com/github/zenonas/endpointer/coverage) [![Issue Count](https://codeclimate.com/github/zenonas/endpointer/badges/issue_count.svg)](https://codeclimate.com/github/zenonas/endpointer)
 
-Endpointer is a small gem that tries to act as a caching proxy between your dev machine and any web service. The motivation was to provide an easy to configure and use fake web service that is able to host host any amount of resources returning canned responses that are easy to modify. Please note the gem is still in early and active development and as such some features may be missing. For a list of features that are still missing consult the list at the end of this readme. If you would like a feature please feel free to raise an issue or a pull request. All contributions are welcome.
+Endpointer is a small gem that tries to act as a caching proxy between your dev machine and any web service. The motivation was to provide an easy to configure and use fake web service that is able to host any amount of resources, returning canned responses, that are easy to modify. Please note the gem is still in early and active development and as such some features may be missing. For a list of features that are still missing consult [the list at the end of this readme](#upcoming-features). If you would like a feature please feel free to raise an issue or a pull request. All contributions are welcome.
 
 ## Requirements
 
-* Ruby 2.0+ (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, and JRuby 9.1.6.0)
 
 ## Installation
 
@@ -47,26 +47,39 @@ You can then invoke endpointer by executing
 
     $ endpointer [--invalidate] <path_to_json_config_file>
 
-Endpointer will attempt to return a cached resource by matching the resource requested with a cached version and if not available will call the real service.
-In order to request for example the above resource from endpointer you would type:
+Or, include it in a config.ru
+
+```ruby
+
+#config.ru
+require 'endpointer'
+
+run Endpointer.app(['--invalidate', '<path_to_json_file>'])
+```
+
+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.
+
+A simple example request to endpointer using cURL:
 
     $ curl http://localhost:4567/get
 
-If the request is to be executed against the real service the headers defined in the config will be used with their default values unless overridden as in the following example:
+If the request is to be executed against the real service the headers defined in the config will be used with their default values unless overridden. An example request overriding the Accept header follows.
 
     $ curl -H "Accept: text/plain" http://localhost:4567/get
 
 ### Caching
 
-By default endpointer will use your operating systems temp directory to store its cache files `(TMP_DIR/endpointer_cache)`. I plan on making this configurable in the future. Possibly as a parameter.
+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>
 
-You can provide the `--invalidate` flag to the command line to invalidate the cache. This empties the endpointer_cache directory
+You can provide the `--invalidate` flag to the command line to invalidate the cache. This empties the endpointer_cache directory.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake` 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).
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
@@ -74,14 +87,12 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/zenona
 
 ### Upcoming features
 
-As mentioned above I'm actively going to work on improving endpointer and the following are a few features that I would like to see implemented. Feel free to suggest new ones or work on one your self.
+As mentioned above I'm actively going to work on improving endpointer and the following are a few features that I would like to see implemented. Feel free to suggest new ones or work on one yourself.
 
-* Custom cache path
 * The ability to easily edit cached files. Maybe a second executable that allows you to edit the canned responses in a pretty JSON format
-* Support all HTTP verbs(currently only GET, POST are supported methods)
 * A `--debug` flag to the command line that will give a pry window on every request allowing you to play with the Request and Response objects.
-* The ability to run headless on a service to make this a deployable fake web service
-* Make the port configurable
+* Configurable port(this can already be done if using config.ru)
+* Support multiple key/value stores for caching. Currently only uses local YAML files. One Suggestion is Redis support.
 
 ## License
 

data/bin/console

@@ -10,5 +10,5 @@ require "endpointer"
 # require "pry"
 # Pry.start
 
-require "irb"
-IRB.start
+require "pry"
+Pry.start

data/bin/endpointer

@@ -3,4 +3,9 @@
 require "bundler/setup"
 require "endpointer"
 
-Endpointer.run ARGV
+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

data/endpointer.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Zen Kyprianou"]
   spec.email         = ["endpointer@zenonas.com"]
 
-  spec.summary       = %q{Faster dev environment with this simple caching proxy DSL}
-  spec.description   = %q{Allows you to define endpoints to serve via a simple caching proxy dsl}
+  spec.summary       = %q{For when you stacks too big for your box}
+  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"
 

data/lib/endpointer/argument_parser.rb

@@ -5,6 +5,11 @@ require 'json'
 module Endpointer
   class ArgumentParser
 
+    VALID_OPTIONS = [
+      '--invalidate',
+      '--cache-dir='
+    ]
+
     def initialize(arguments)
       @arguments = arguments
     end
@@ -20,11 +25,23 @@ module Endpointer
       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
+    end
+
     private
 
     def build_options_from(parsed_options)
       invalidate = parsed_options.include?("--invalidate")
-      Options.new(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
@@ -35,9 +52,6 @@ module Endpointer
       JSON.parse(File.read(config_file))
     end
 
-    def resources_from_config_file
-    end
-
     def option_argument?(argument)
       argument.match(/^--.*/)
     end

data/lib/endpointer/cacher.rb

@@ -1,4 +1,5 @@
 require 'endpointer/errors/cached_item_not_found_error'
+require 'endpointer/errors/invalid_cache_dir_error'
 require 'endpointer/cache_container'
 require 'yaml'
 
@@ -40,8 +41,12 @@ module Endpointer
     end
 
     def initialize_path(path)
-      @path = path
-      Dir.mkdir(@path) unless File.exists?(@path)
+      begin
+        @path = path
+        Dir.mkdir(@path) unless File.exists?(@path)
+      rescue Errno::ENOENT => e
+        raise Endpointer::Errors::InvalidCacheDirError.new(e.message)
+      end
     end
   end
 end

data/lib/endpointer/errors/invalid_arguments_error.rb

@@ -0,0 +1,7 @@
+module Endpointer
+  module Errors
+    class InvalidArgumentsError < StandardError
+
+    end
+  end
+end

data/lib/endpointer/errors/invalid_cache_dir_error.rb

@@ -0,0 +1,7 @@
+module Endpointer
+  module Errors
+    class InvalidCacheDirError < StandardError
+
+    end
+  end
+end

data/lib/endpointer/options.rb

@@ -1,4 +1,11 @@
 module Endpointer
-  class Options < Struct.new(:invalidate)
+  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

data/lib/endpointer/performer_factory.rb

@@ -6,7 +6,10 @@ module Endpointer
 
     PERFORMERS = {
       get: Endpointer::Performers::Get,
-      post: Endpointer::Performers::Post
+      post: Endpointer::Performers::Post,
+      put: Endpointer::Performers::Post,
+      patch: Endpointer::Performers::Post,
+      delete: Endpointer::Performers::Get
     }
 
     def self.create(method)

data/lib/endpointer/performers/get.rb

@@ -4,12 +4,19 @@ require 'rest-client'
 
 module Endpointer
   module Performers
-    class Get < Method
+    class Get
+      include Endpointer::Performers::Method
 
       def execute(request, resource)
+        execute_method(resource.method, request, resource)
+      end
+
+      private
+
+      def execute_method(method, request, resource)
         begin
           url = File.join(create_hostname(resource), create_path(request))
-          response = RestClient::Request.execute(method: :get, url: url, headers: create_headers(request, resource))
+          response = RestClient::Request.execute(method: method, url: url, headers: create_headers(request, resource))
         rescue RestClient::ExceptionWithResponse => e
           response = e.response
         end

data/lib/endpointer/performers/method.rb

@@ -3,13 +3,7 @@ require 'uri'
 
 module Endpointer
   module Performers
-    class Method
-
-      def execute(request, resource)
-      end
-
-      private
-
+    module Method
       def create_headers(request, resource)
         resource.headers.keys.each_with_object({}) do |key, header|
           header[key] = request_header_or_default(key, request, resource)

data/lib/endpointer/performers/post.rb

@@ -4,11 +4,19 @@ require 'rest-client'
 
 module Endpointer
   module Performers
-    class Post < Method
+    class Post
+      include Endpointer::Performers::Method
+
       def execute(request, resource)
+        execute_method(resource.method, request, resource)
+      end
+
+      private
+
+      def execute_method(method, request, resource)
         begin
           url = File.join(create_hostname(resource), create_path(request))
-          response = RestClient.post(
+          response = RestClient.send(method,
             url,
             request.body.string,
             create_headers(request, resource)

data/lib/endpointer/performers.rb

@@ -1,3 +1,2 @@
 require 'endpointer/performers/get'
 require 'endpointer/performers/post'
-

data/lib/endpointer/resource_executor.rb

@@ -6,19 +6,18 @@ module Endpointer
 
     def perform(request, resource, options)
       begin
-        cache.get(resource)
+        cache(options.cache_dir).get(resource)
       rescue Endpointer::Errors::CachedItemNotFoundError => e
         response = Endpointer::PerformerFactory.create(resource.method).execute(request, resource)
-        cache.set(resource, response)
+        cache(options.cache_dir).set(resource, response)
         response
       end
     end
 
     private
 
-    def cache
-      @cache ||= Endpointer::Cacher.new(Endpointer::CACHE_DIR)
+    def cache(cache_dir)
+      @cache ||= Endpointer::Cacher.new(cache_dir)
     end
-
   end
 end

data/lib/endpointer/version.rb

@@ -1,3 +1,3 @@
 module Endpointer
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/endpointer.rb

@@ -1,16 +1,19 @@
 require "endpointer/version"
 require "endpointer/argument_parser"
 require "endpointer/app_creator"
+require "endpointer/errors/invalid_arguments_error"
 
 module Endpointer
 
-  CACHE_DIR = File.join(Dir.tmpdir, "endpointer_cache")
-
   def self.run(arguments)
+    app(arguments).run!
+  end
+
+  def self.app(arguments)
     argument_parser = ArgumentParser.new(arguments)
+    raise Errors::InvalidArgumentsError unless argument_parser.valid?
     options = argument_parser.parse_options
-    Cacher.new(CACHE_DIR).invalidate if options.invalidate
-    app = AppCreator.new.create(argument_parser.parse_resources, options)
-    app.run!
+    Cacher.new(options.cache_dir).invalidate if options.invalidate
+    AppCreator.new.create(argument_parser.parse_resources, options)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: endpointer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Zen Kyprianou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-30 00:00:00.000000000 Z
+date: 2017-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,7 +150,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Allows you to define endpoints to serve via a simple caching proxy dsl
+description: Allows you to define endpoints to serve via a small caching proxy
 email:
 - endpointer@zenonas.com
 executables:
@@ -169,7 +169,6 @@ files:
 - Rakefile
 - bin/console
 - bin/endpointer
-- bin/setup
 - endpointer.gemspec
 - lib/endpointer.rb
 - lib/endpointer/app.rb
@@ -178,6 +177,8 @@ files:
 - lib/endpointer/cache_container.rb
 - lib/endpointer/cacher.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
@@ -213,5 +214,5 @@ rubyforge_project:
 rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: Faster dev environment with this simple caching proxy DSL
+summary: For when you stacks too big for your box
 test_files: []

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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