LVS-JSONService 0.4.6 → 0.4.7

data/.specification

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: LVS-JSONService 
 version: !ruby/object:Gem::Version 
-  version: 0.4.6
+  version: 0.4.7
 require_paths:
 - lib
 platform: ruby

data/LVS-JSONService.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{LVS-JSONService}
-  s.version = "0.4.6"
+  s.version = "0.4.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["LVS", "andyjeffries"]
@@ -10,14 +10,14 @@ Gem::Specification.new do |s|
   s.email = %q{info@lvs.co.uk}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.textile"
   ]
   s.files = [
     ".gitignore",
      ".specification",
      "LVS-JSONService.gemspec",
      "LICENSE",
-     "README.rdoc",
+     "README.textile",
      "Rakefile",
      "VERSION",
      "lib/json_service.rb",

data/README.textile

@@ -0,0 +1,97 @@
+h2. Purpose
+
+This gem is an internal LVS project for communicating with an AGP (Advanced Gaming Platform) backend server.
+
+h2. History
+
+In the old days there was the WebApi classes which used XML-RPC.  Then there was the 'new' ABP::API::JSN class (why JSON is abbreviated to JSN is unknown) which has all the JSON API calls in one class.
+
+This felt very un-Railsy, so Andy Jeffries wrote the new JsonService parent class, so we can treat each group of JSON services like a model.  This is similar to the way ActiveResource works (but we can't use ActiveResource as our models aren't really resources).
+
+h2. Example
+
+As a simple example of how to create a new model based JSON API class:
+
+<pre><code>require 'json_service'
+
+class Event < LVS::JsonService::Base
+  self.site = AGP_LOCATION + '/jsonservices/'
+  self.service_prefix = 'com.lvsint.abp.client.json.commands.'
+  self.field_prefix = 'event_'
+  
+  define_service :special, 'DoSomethingSpecial.json', 
+    :defaults => {:n => 5}, :required => [:n, :locale]
+  
+  define_service :details, 'ListAllEvents.json',
+    :defaults => {:searchType => Event::SEARCH_TYPE_IDS}, 
+    :required => [:searchType, :searchIds],
+    :optional => [:locale, :period, :includeEventInfoYN]
+
+end</code></pre>
+
+You then use it just like an ActiveRecord model (at the moment it's read only - we'll add write capabilities to it in an ActiveRecord style when we need them):
+
+<pre><code>events = Event.special :locale => "en-gb"
+events.each do |event|
+  puts "#{event.id} #{event.title}"
+end</code></pre>
+
+The field names come from the JSON return field names after the field_prefix is stripped off (if present).
+
+There is also a bit of magic that converts fields ending in 'date' to be a Time value, and fields starting with has_ such as has_bets to return a boolean (and create a bets? method too).
+
+h2. Combined results
+
+The first version of json_service only worked if the result was an array of hashes.  The latest version will now accept a hash as the result and make any elements that have arrays as the values an array of objects.  For example, given the JSON as follows:
+
+<pre><code>{
+  'event_id': 132,
+  'event_location': 'Anfield, Liverpool, England',
+  'teams': [
+    {
+      'name': 'Liverpool',
+      'colour': 'Red'
+    },
+    {
+      'name': 'Everton',
+      'colour': 'Blue'
+    }
+  ]
+}</code></pre>
+
+You could then use the class in this way:
+
+<pre><code>event = Event.my_combined_call :locale => "en-gb"
+puts "ID: " + event.id
+puts "Location: " + event.location
+events.teams.each do |team|
+  puts "#{team.name}(#{event.colour})"
+end</code></pre>
+
+h2. Faking calls
+
+There are times when you're ready to develop on the Rails side but the Web API isn't ready.  You can create a fake service that just parses a hard-coded JSON string in the same way as it would if it had come back from the Web API.
+
+<pre><code>class Event < LVS::JsonService::Base
+  self.site = AGP_LOCATION + '/jsonservices/'
+  self.service_prefix = 'com.lvsint.abp.client.json.commands.'
+  self.field_prefix = 'event_'
+  
+  fake_service :special, '{"status":"OK", "count":2}'
+end</code></pre>
+
+h2. Communication Resiliancy
+
+The AGP backend doesn't always reliably allow a connection and prompt response.  Therefore there is now the facility to define a timeout for a connection (and response) and an amount of retries rather than immediately failing.
+
+The new parameters are defined as per the following example:
+
+<pre><code>  define_service :last_minute, 'FDJListLastMinuteEventsService.json', 
+    :defaults => {:n => 5}, :required => [:n, :locale], :timeout => 3, :retries => 3</code></pre>
+
+The default values are 1 second timeout (note: this is actually 1 second connection timeout and 1 second read timeout, so 2 seconds total) and 0 retries.
+
+If it fails to connect or times out, it retries <code>:retries</code> times with timeout set to <code>:timeout</code> + 50%.
+
+
+Copyright (C) 2009-2010 LVS Ltd.

data/VERSION

@@ -1 +1 @@
-0.4.6
+0.4.7

data/lib/lvs/json_service/connection_manager.rb

@@ -17,7 +17,7 @@ module LVS
         key = create_key(host, port)
         begin
           LVS::JsonService::Logger.debug "Disconnecting from #{host}:#{port}"
-          @@connections[key].finish
+          @@connections[key].finish if @@connections[key]
         rescue IOError
           # Do nothing
         end
@@ -29,7 +29,7 @@ module LVS
         @@connections.each do |key, connection|
           begin
             LVS::JsonService::Logger.debug "Disconnecting from #{host}:#{port}"
-            connection.finish
+            connection.finish if connection
           rescue IOError
             # Do nothing
           end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: LVS-JSONService
 version: !ruby/object:Gem::Version 
-  version: 0.4.6
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 7
+  version: 0.4.7
 platform: ruby
 authors: 
 - LVS
@@ -10,39 +15,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-20 00:00:00 +01:00
+date: 2010-01-20 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
         version: 2.3.5
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: eventmachine
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 12
+        - 10
         version: 0.12.10
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: em-http-request
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 6
         version: 0.2.6
-    version: 
+  type: :runtime
+  version_requirements: *id003
 description: 
 email: info@lvs.co.uk
 executables: []
@@ -51,13 +68,13 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.textile
 files: 
 - .gitignore
 - .specification
 - LVS-JSONService.gemspec
 - LICENSE
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - lib/json_service.rb
@@ -90,18 +107,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A Ruby library for interacting with external JSON services

data/README.rdoc

@@ -1,7 +0,0 @@
-= JSONService
-
-Description goes here.
-
-== Copyright
-
-Copyright (c) 2009 LVS. See LICENSE for details.