sitra_client 0.0.2 → 0.0.3

data/lib/sitra_client/sitra_response.rb

@@ -1,4 +1,5 @@
 require 'sitra_client/attribute_helper'
+require 'sitra_client/touristic_object'
 require 'json'
 
 class SitraResponse
@@ -19,4 +20,14 @@ class SitraResponse
     @json_response
   end
 
+  def as_array
+    response = as_hash
+    if response[:objetsTouristiques].nil?
+      results = []
+    else
+      results = response[:objetsTouristiques].collect {|obj_hash| TouristicObject.new(obj_hash)}
+    end
+    results
+  end
+
 end

data/lib/sitra_client/touristic_object.rb

@@ -0,0 +1,121 @@
+# encoding: UTF-8
+require 'sitra_client/attribute_helper'
+
+class TouristicObject
+
+  include AttributeHelper
+
+  def initialize(hash)
+    self.attributes = hash
+  end
+
+  def id
+    @id.to_s
+  end
+
+  def title
+    @nom[:libelleFr]
+  end
+
+  def description
+    @presentation[:descriptifCourt][:libelleFr] unless @presentation[:descriptifCourt].nil?
+  end
+
+  def details
+    @presentation[:descriptifDetaille][:libelleFr] unless @presentation[:descriptifDetaille].nil?
+  end
+
+  def contact
+    contact_details = {}
+    contact_entries = @informations[:moyensCommunication].nil? ? [] : @informations[:moyensCommunication]
+    contact_entries.each do |c|
+      label = c[:type][:libelleFr]
+      contact_details[c[:type][:libelleFr]] = c[:coordonnee] unless label == 'Fax'
+    end
+    contact_details
+  end
+
+  def picture_url(default_url)
+    @imagePrincipale.nil? ? default_url : @imagePrincipale[:traductionFichiers][0][:url]
+  end
+
+  def service_provider
+    if @informationsActivite && @informationsActivite[:commerceEtServicePrestataire]
+      @informationsActivite[:commerceEtServicePrestataire][:nom][:libelleFr]
+    elsif @informationsFeteEtManifestation
+      @informationsFeteEtManifestation[:nomLieu]
+    else
+      nil
+    end
+  end
+
+  def address_details
+    if @informationsActivite && @informationsActivite[:commerceEtServicePrestataire]
+      @informationsActivite[:commerceEtServicePrestataire][:adresse]
+    else
+      @localisation[:adresse]
+    end
+  end
+
+  def address
+    "#{address_details[:adresse1]}, #{address_details[:commune][:nom]}"
+  end
+
+  def latitude
+    geoloc_details = parse_geoloc_details
+    geoloc_details[:valide] ? geoloc_details[:geoJson][:coordinates][1] : nil
+  end
+
+  def longitude
+    geoloc_details = parse_geoloc_details
+    geoloc_details[:valide] ? geoloc_details[:geoJson][:coordinates][0] : nil
+  end
+
+  def horaires
+    if @ouverture && @ouverture[:periodeEnClair]
+      @ouverture[:periodeEnClair][:libelleFr]
+    end
+  end
+
+  def tarif
+    if @descriptionTarif
+      if @descriptionTarif[:gratuit]
+        return 'gratuit'
+      elsif @descriptionTarif[:tarifsEnClair]
+        @descriptionTarif[:tarifsEnClair][:libelleFr]
+      end
+    end
+  end
+
+  def population
+    eligible_populations = []
+    if @prestations && @prestations[:typesClientele]
+      eligible_populations += @prestations[:typesClientele].collect {|t| t[:libelleFr]}
+    end
+    eligible_populations.uniq
+  end
+
+  def adapted_tourism
+    @prestations && @prestations[:tourismesAdaptes] && @prestations[:tourismesAdaptes].collect {|t| t[:libelleFr]}
+  end
+
+  def environments
+    @localisation && @localisation[:environnements] && @localisation[:environnements].collect {|e| e[:libelleFr]}
+  end
+
+  def additional_criteria
+    @presentation && @presentation[:typologiesPromoSitra] && @presentation[:typologiesPromoSitra].collect {|t| t[:libelleFr]}
+  end
+
+  private
+
+  def parse_geoloc_details
+    if @informationsActivite.nil? || @informationsActivite[:commerceEtServicePrestataire].nil?
+      geoloc_details = @localisation[:geolocalisation]
+    else
+      geoloc_details = @informationsActivite[:commerceEtServicePrestataire][:geolocalisation]
+    end
+    geoloc_details
+  end
+
+end

data/lib/sitra_client/version.rb

@@ -1,3 +1,3 @@
 module SitraClient
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/sitra_client/sitra_response_test.rb

@@ -34,4 +34,33 @@ class SitraResponseTest < Test::Unit::TestCase
 
   end
 
+  should 'return an array of touristic objects' do
+
+    json_response = '{ "numFound" : 2, "objetsTouristiques" : [ {"id" : 1, "nom" : {"libelleFr" : "my_first_object"} }, {"id" : 2, "nom" : {"libelleFr" : "my_second_object"} } ] }'
+
+    sitra_response = SitraResponse.new
+    sitra_response.append_line(json_response)
+
+    touristic_objects = sitra_response.as_array
+
+    assert_equal 2, touristic_objects.length
+    assert_equal "1", touristic_objects[0].id
+    assert_equal "my_first_object", touristic_objects[0].title
+    assert_equal "2", touristic_objects[1].id
+    assert_equal "my_second_object", touristic_objects[1].title
+
+  end
+
+  should 'return empty array when no data is available' do
+
+    json_response = '{ "numFound" : 2 }'
+
+    sitra_response = SitraResponse.new
+    sitra_response.append_line(json_response)
+
+    touristic_objects = sitra_response.as_array
+    assert_empty touristic_objects
+
+  end
+
 end

data/test/sitra_client/touristic_object_test.rb

@@ -0,0 +1,134 @@
+# encoding : UTF-8
+require 'rubygems'
+gem 'shoulda'
+require 'test/unit'
+require 'shoulda'
+require 'sitra_client/touristic_object'
+
+class TouristicObjectTest < Test::Unit::TestCase
+
+  should 'populate title of touristic object' do
+    hash_result = {:nom => {:libelleFr => "my_title"}}
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'my_title', touristic_object.title
+  end
+
+  should 'populate description of touristic object' do
+    hash_result = {:presentation => {:descriptifCourt => {:libelleFr => "my_description"}}}
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'my_description', touristic_object.description
+  end
+
+  should 'populate detailed description of touristic object' do
+    hash_result = {:presentation => {:descriptifDetaille => {:libelleFr => "my_detailed_description"}}}
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'my_detailed_description', touristic_object.details
+  end
+
+  should 'populate contact details' do
+    hash_result = {
+        :informations => {
+            :moyensCommunication => [
+                {:type => {:libelleFr => "Téléphone"}, :coordonnee => "0123456789"},
+                {:type => {:libelleFr => "Fax"}, :coordonnee => "9876543201"}
+            ]
+        }
+    }
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal({'Téléphone' => '0123456789'}, touristic_object.contact)
+  end
+
+  should 'populate image details' do
+    hash_result = {:imagePrincipale => {:traductionFichiers => [{:url => "my/image/url"}]}}
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'my/image/url', touristic_object.picture_url('default.png')
+  end
+
+  should 'populate address details' do
+    hash_result = {
+        :informationsActivite => {
+            :commerceEtServicePrestataire => {
+                :nom => {:libelleFr => "my_service"},
+                :adresse => {:adresse1 => "my_address", :codePostal => "1234", :commune => {:nom => "my_city"}},
+                :geolocalisation => {:valide => true, :geoJson => {:coordinates => [0.1, 0.2]}}
+            }
+        }
+    }
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'my_service', touristic_object.service_provider
+    assert_equal 'my_address, my_city', touristic_object.address
+    assert_equal 0.2, touristic_object.latitude
+    assert_equal 0.1, touristic_object.longitude
+  end
+
+  should 'use event details when available' do
+    hash_result = {:informationsFeteEtManifestation => {:nomLieu => "my_place"}}
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'my_place', touristic_object.service_provider
+  end
+
+  should 'fallback to localisation address when service details are missing' do
+    hash_result = {
+        :localisation => {
+            :adresse => {:adresse1 => "my_address", :codePostal => "1234", :commune => {:nom => "my_city"}},
+            :geolocalisation => {:valide => true, :geoJson => {:coordinates => [0.1, 0.2]}}
+        },
+        :informationsActivite => {}
+    }
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_nil touristic_object.service_provider
+    assert_equal 'my_address, my_city', touristic_object.address
+    assert_equal 0.2, touristic_object.latitude
+    assert_equal 0.1, touristic_object.longitude
+  end
+
+  should 'populate opening hours when available' do
+    hash_result = {:ouverture => {:periodeEnClair => {:libelleFr => "my_opening_hours"}}}
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'my_opening_hours', touristic_object.horaires
+  end
+
+  should 'populate tariffs data when available' do
+    hash_result = {
+        :descriptionTarif => {:gratuit => false,
+                              :tarifsEnClair => {:libelleFr => "my_tariff_description"}
+        }
+    }
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'my_tariff_description', touristic_object.tarif
+  end
+
+  should 'tag free oject when relevant' do
+    hash_result = {:descriptionTarif => {:gratuit => true}}
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal 'gratuit', touristic_object.tarif
+  end
+
+  should 'populate populations information' do
+    hash_result = {
+        :prestations => {:typesClientele => [{:libelleFr => "Familles"}]}
+    }
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_equal ['Familles'], touristic_object.population
+  end
+
+  should 'populate adapted tourism fields' do
+    hash_result = {:prestations => {:tourismesAdaptes => [{:libelleFr => "Accessible en fauteuil roulant en autonomie"}]}}
+    touristic_object = TouristicObject.new(hash_result)
+
+    assert_true touristic_object.adapted_tourism.include?('Accessible en fauteuil roulant en autonomie')
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sitra_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,10 +123,12 @@ files:
 - lib/sitra_client/attribute_helper.rb
 - lib/sitra_client/sitra_query.rb
 - lib/sitra_client/sitra_response.rb
+- lib/sitra_client/touristic_object.rb
 - lib/sitra_client/version.rb
 - sitra_client.gemspec
 - test/sitra_client/sitra_query_test.rb
 - test/sitra_client/sitra_response_test.rb
+- test/sitra_client/touristic_object_test.rb
 homepage: https://github.com/jeanbaptistevilain/sitra_client
 licenses:
 - MIT
@@ -155,3 +157,4 @@ summary: A simple Ruby wrapper for the SITRA JSON api
 test_files:
 - test/sitra_client/sitra_query_test.rb
 - test/sitra_client/sitra_response_test.rb
+- test/sitra_client/touristic_object_test.rb