euston-websites 1.0.0

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    euston-websites (1.0.0)
+      activesupport (>= 3.0.10)
+      hollywood
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    awesome_print (0.4.0)
+    diff-lcs (1.1.3)
+    fuubar (0.0.6)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.8)
+      ruby-progressbar (~> 0.0.10)
+    hollywood (1.0.0)
+    multi_json (1.0.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.9)
+    rspec-mocks (2.6.0)
+    ruby-progressbar (0.0.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print (~> 0.4.0)
+  euston-websites!
+  fuubar (~> 0.0.0)
+  rspec (~> 2.6.0)

data/Rakefile

@@ -0,0 +1,161 @@
+require 'date'
+require 'rspec/core/rake_task'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name, provider = nil)
+  if provider
+    value = send(provider)
+  else
+    value = "'#{send(header_name)}'"
+  end
+
+  provider ||= header_name
+  head.sub!(/(\.#{header_name}\s*= ).*/) { "#{$1}#{value}"}
+end
+
+def platform
+  jruby? ? '-java' : ''
+end
+
+def platform_dependant_gem_file
+  "#{name}-#{version}#{platform}.gem"
+end
+
+def platform_dependent_version
+  "'#{version}#{platform}'"
+end
+
+def jruby?
+  RUBY_PLATFORM.to_s == 'java'
+end
+
+def trim_array_ends array
+  array.shift
+  array.pop
+  array
+end
+
+#############################################################################
+#
+# Custom tasks
+#
+#############################################################################
+
+default_rspec_opts = %w[--colour --format Fuubar]
+
+desc "Run all examples"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = default_rspec_opts
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+def built_gem
+  @built_gem ||= Dir["#{name}*.gem"].first
+end
+
+desc "Create tag v#{platform_dependent_version} and build and push #{platform_dependant_gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+
+  sh "git commit --allow-empty -a -m 'Release #{platform_dependent_version}'"
+  sh "git tag v#{platform_dependent_version}"
+  sh "git push origin master"
+  sh "git push origin v#{platform_dependent_version}"
+
+  command = "gem push pkg/#{platform_dependant_gem_file}"
+
+  if jruby?
+    puts "--------------------------------------------------------------------------------------"
+    puts "can't push to rubygems using jruby at the moment, so switch to mri and run: #{command}"
+    puts "--------------------------------------------------------------------------------------"
+  else
+    sh command
+  end
+end
+
+desc "Build #{platform_dependant_gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{built_gem} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  #replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/euston-websites.gemspec

@@ -0,0 +1,36 @@
+Gem::Specification.new do |s|
+  s.name        = 'euston-websites'
+  s.version     = '1.0.0'
+  s.platform    = RUBY_PLATFORM.to_s == 'java' ? 'java' : Gem::Platform::RUBY
+  s.authors     = ['Lee Henson', 'Guy Boertje']
+  s.email       = ['lee.m.henson@gmail.com', 'guyboertje@gmail.com']
+  s.summary     = %q{Common functionality for interacting with euston from websites.}
+  s.description = ""
+  s.homepage    = 'http://github.com/leemhenson/euston-websites'
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    euston-websites.gemspec
+    lib/euston-websites.rb
+    lib/euston-websites/api_command_request_parsing/abstract_parser.rb
+    lib/euston-websites/api_command_request_parsing/batch_parser.rb
+    lib/euston-websites/api_command_request_parsing/discrete_parser.rb
+    lib/euston-websites/api_version.rb
+    lib/euston-websites/version.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_dependency 'activesupport',                 '>= 3.0.10'
+  s.add_dependency 'hash-keys',                     '~> 1.0.1'
+  s.add_dependency 'hollywood',                     '~> 1.0.0'
+
+  s.add_development_dependency 'awesome_print',     '~> 0.4.0'
+  s.add_development_dependency 'fuubar',            '~> 0.0.0'
+  s.add_development_dependency 'rspec',             '~> 2.6.0'
+end

data/lib/euston-websites.rb

@@ -0,0 +1,8 @@
+require 'active_support/json'
+require 'hash-keys'
+require 'hollywood'
+
+require 'euston-websites/api_version'
+require 'euston-websites/api_command_request_parsing/abstract_parser'
+require 'euston-websites/api_command_request_parsing/batch_parser'
+require 'euston-websites/api_command_request_parsing/discrete_parser'

data/lib/euston-websites/api_command_request_parsing/abstract_parser.rb

@@ -0,0 +1,34 @@
+module Euston
+module Websites
+module ApiCommandRequestParsing
+  class AbstractParser
+    include Hollywood
+
+    def initialize request
+      @body = request.body.read
+    end
+
+    def parse
+      valid = true
+
+      begin
+        commands = [transform_hash_to_commands(ActiveSupport::JSON.decode(@body))].flatten
+      rescue StandardError => e
+        callback :not_parseable
+        valid = false
+      end
+
+      return unless valid
+
+      invalid_commands = commands.reject { |c| c.valid? }
+
+      if invalid_commands.any?
+        callback :invalid, invalid_commands
+      else
+        callback :valid, commands
+      end
+    end
+  end
+end
+end
+end

data/lib/euston-websites/api_command_request_parsing/batch_parser.rb

@@ -0,0 +1,16 @@
+module Euston
+module Websites
+module ApiCommandRequestParsing
+  class BatchParser < AbstractParser
+    def initialize request, &block
+      super request
+      @transformer = block
+    end
+
+    def transform_hash_to_commands hash
+      @transformer.call hash
+    end
+  end
+end
+end
+end

data/lib/euston-websites/api_command_request_parsing/discrete_parser.rb

@@ -0,0 +1,23 @@
+module Euston
+module Websites
+module ApiCommandRequestParsing
+  class DiscreteParser < AbstractParser
+    def initialize request, params, command_type, command_id = nil
+      super request
+      @command_id = command_id || params[:id]
+      @command_type = command_type
+    end
+
+    def transform_hash_to_commands hash
+      hash = hash.recursive__symbolize__keys!
+
+      callback :preparing_hash, hash
+
+      command = @command_type.new hash
+      command.id = @command_id
+      command
+    end
+  end
+end
+end
+end

data/lib/euston-websites/api_version.rb

@@ -0,0 +1,36 @@
+# Taken from:
+# http://freelancing-gods.com/posts/versioning_your_ap_is
+
+module Euston
+module Websites
+  class ApiVersion
+    def initialize version
+      @version = version
+    end
+
+    def matches? request
+      versioned_accept_header?(request) || version_one?(request)
+    end
+
+    private
+
+    def vendor_application_id
+      # abstract
+    end
+
+    def version_one? request
+      @version == 1 && unversioned_accept_header?(request)
+    end
+
+    def versioned_accept_header? request
+      accept = request.headers['Accept']
+      accept && accept[/application\/vnd\.#{vendor_application_id}-v#{@version}\+json/]
+    end
+
+    def unversioned_accept_header? request
+      accept = request.headers['Accept']
+      accept.blank? || accept[/application\/vnd\.#{vendor_application_id}/].nil?
+    end
+  end
+end
+end

data/lib/euston-websites/version.rb

@@ -0,0 +1,5 @@
+module Euston
+  module Websites
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: euston-websites
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Lee Henson
+- Guy Boertje
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70308955942160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: *70308955942160
+- !ruby/object:Gem::Dependency
+  name: hash-keys
+  requirement: &70308955941680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70308955941680
+- !ruby/object:Gem::Dependency
+  name: hollywood
+  requirement: &70308955941220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70308955941220
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: &70308955940760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :development
+  prerelease: false
+  version_requirements: *70308955940760
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: &70308955331480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70308955331480
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70308955330540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70308955330540
+description: ''
+email:
+- lee.m.henson@gmail.com
+- guyboertje@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- euston-websites.gemspec
+- lib/euston-websites.rb
+- lib/euston-websites/api_command_request_parsing/abstract_parser.rb
+- lib/euston-websites/api_command_request_parsing/batch_parser.rb
+- lib/euston-websites/api_command_request_parsing/discrete_parser.rb
+- lib/euston-websites/api_version.rb
+- lib/euston-websites/version.rb
+homepage: http://github.com/leemhenson/euston-websites
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Common functionality for interacting with euston from websites.
+test_files: []