fragment_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3a35f593d6abe9192c15b031170a641bec01aa8
+  data.tar.gz: 42a3637c7f04786e2e2e26c8e9bf84ecca9eb3f9
+SHA512:
+  metadata.gz: 9a1e0322f94064a74b9e6ea7c01ccac85d72ad9377d0e7473a3b41b442d398d77f87357836f7c56e6bd7062af25e85f98abecbd621da1c9d57bf14edfaa44c2c
+  data.tar.gz: 7bbdb7cbb840d75c29fc8d946e69d8c0232167ba09449c33db22c293e48ead1f9dadbfde99b7afe79474b46f18ca9d50eaf20ddc0257bb1650a7b37130f709d9

data/README.md

@@ -0,0 +1,27 @@
+#Fragment client
+A Ruby gem that provides an interface to the fragment_server for easy use in web apps. The client's main responsibility is to construct requests and handle caching of response strings.
+
+##Usage
+The fragment client provides an easy method to fetch snippets of markup from the fragment server. E.G.
+
+```ruby
+client = FragmentClient.new
+client.fetch('footer')
+client.fetch('navigation', options)
+```
+
+`options` is a hash of values used to construct the API query. The default values are listed below:
+
+```ruby
+{
+  has_log_in: true,  # true || false
+  logged_in: false,  # true || false
+  logo: 'red'        # 'red' || 'black'
+}
+```
+
+<sup>*currently, only the navigation method has options</sup>
+
+##Caching
+
+Caching is achieved by The fragment client attempts to cache responses wherever possible.

data/lib/fragment_client/fragment_client.rb

@@ -0,0 +1,34 @@
+require 'json'
+
+class FragmentClient
+  attr_accessor :fragment_server_url, :option_params, :cache
+  DEFAULT_URL = 'http://test-eva-fragment-server.herokuapp.com/fragments/full.json?'
+
+  def initialize(fragment_server_url=DEFAULT_URL, cache=MemoryCache.new)
+    self.fragment_server_url = fragment_server_url
+    self.cache               = cache
+  end
+
+  def fetch(section, options={})
+    set_params(options)
+    cache.fetch(section + option_params) { request[section] }
+  end
+
+  private
+
+  def set_params(options={})
+    self.option_params = URI.encode_www_form(default_options.merge(options).sort)
+  end
+
+  def default_options
+    { has_login: true, logged_in: false, logo: 'red'}
+  end
+
+  def request
+    JSON.parse(Net::HTTP.get(uri))
+  end
+
+  def uri
+    URI(fragment_server_url + option_params)
+  end
+end

data/lib/fragment_client/memory_cache.rb

@@ -0,0 +1,23 @@
+class MemoryCache
+  attr_accessor :cache
+
+  def initialize
+    self.cache = {}
+  end
+
+  def fetch(key, &block)
+    validate?(key) ? read(key) : write(key, block.call)['entry']
+  end
+
+  def read(key)
+    cache[key]['entry']
+  end
+
+  def write(key, value)
+    self.cache[key] = { 'created_at' => Time.now, 'entry' => value } unless value.blank?
+  end
+
+  def validate?(key)
+    cache[key] && (Time.now - cache[key]['created_at']) < 1.hours
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: fragment_client
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Anthony Atkinson
+- Joe Love
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails-timeago
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: A Ruby gem that provides an interface to the fragment_server for easy
+  use in web apps. This works for any ruby app.
+email:
+- anthony.atkinson@which.co.uk
+- joe.love@which.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/fragment_client/fragment_client.rb
+- lib/fragment_client/memory_cache.rb
+homepage: https://github.com/whichdigital/fragment_client
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Ruby gem that provides an interface to the fragment_server for easy use
+  in web apps.
+test_files: []