sitra_client 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sitra_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jeanbaptistevilain
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# SitraClient
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sitra_client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sitra_client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.verbose = true
+  t.pattern = '**/*_test.rb'
+end

data/lib/sitra_client/attribute_helper.rb

@@ -0,0 +1,11 @@
+module AttributeHelper
+  def attributes=(hash)
+    hash.each do |key, value|
+      instance_variable_set("@#{key}", value)
+    end
+  end
+
+  def attributes
+    Hash[instance_variables.map { |name| [name.to_s[1..-1], instance_variable_get(name)] }]
+  end
+end

data/lib/sitra_client/sitra_query.rb

@@ -0,0 +1,18 @@
+require 'sitra_client/attribute_helper'
+require 'json'
+
+class SitraQuery
+
+  include AttributeHelper
+
+  def initialize(api_key, site_identifier, criteria = {})
+    @apiKey = api_key
+    @siteWebExportIdV1 = site_identifier
+    self.attributes = criteria
+  end
+
+  def to_params
+    JSON.generate attributes
+  end
+
+end

data/lib/sitra_client/sitra_response.rb

@@ -0,0 +1,24 @@
+require 'sitra_client/attribute_helper'
+require 'json'
+
+class SitraResponse
+
+  include AttributeHelper
+
+  def initialize
+    @json_response = ''
+  end
+
+  def append_line(line)
+    @json_response += line unless line.nil?
+  end
+
+  def as_hash
+    JSON.parse @json_response, :symbolize_names => true
+  end
+
+  def as_raw_json
+    @json_response
+  end
+
+end

data/lib/sitra_client/version.rb

@@ -0,0 +1,3 @@
+module SitraClient
+  VERSION = "0.0.1"
+end

data/lib/sitra_client.rb

@@ -0,0 +1,37 @@
+require 'sitra_client/version'
+require 'sitra_client/sitra_query'
+require 'sitra_client/sitra_response'
+require 'open-uri'
+
+module SitraClient
+
+  # Configuration defaults
+  @config = {
+      :base_url => 'http://api.sitra-tourisme.com/api/v001',
+      :api_key => '',
+      :site_identifier => ''
+  }
+
+  @valid_config_keys = @config.keys
+  @logger = Logger.new(STDOUT)
+
+  # Configure through hash
+  def self.configure(opts = {})
+    opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+  end
+
+  def self.config
+    @config
+  end
+
+  def self.query(criteria = {})
+    response = SitraResponse.new
+    query = SitraQuery.new(@config[:api_key], @config[:site_identifier], criteria)
+    @logger.info "Search query : #{@config[:base_url]}/recherche/list-objets-touristiques?query=#{query.to_params}"
+    open("#{@config[:base_url]}/recherche/list-objets-touristiques?query=#{CGI.escape query.to_params}") { |f|
+      f.each_line {|line| response.append_line(line)}
+    }
+    response
+  end
+
+end

data/sitra_client.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sitra_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sitra_client"
+  spec.version       = SitraClient::VERSION
+  spec.authors       = ["jeanbaptistevilain"]
+  spec.email         = ["jbvilain@gmail.com"]
+  spec.description   = %q{Sitra Client Gem}
+  spec.summary       = %q{A simple Ruby wrapper for the SITRA JSON api}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit"
+  spec.add_development_dependency "shoulda"
+  spec.add_runtime_dependency "rails", "~> 3.2.14"
+  spec.add_runtime_dependency "json"
+end

data/test/sitra_client/sitra_query_test.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+gem 'shoulda'
+require 'test/unit'
+require 'shoulda'
+require 'sitra_client/sitra_query'
+
+class SitraQueryTest < Test::Unit::TestCase
+
+  should 'populate query with parameters' do
+
+    query = SitraQuery.new('dummy_key', 'dummy_identifier', {:first_key => 'first_value', :second_key => 'second_value'})
+
+    assert_equal '{"apiKey":"dummy_key","siteWebExportIdV1":"dummy_identifier","first_key":"first_value","second_key":"second_value"}', query.to_params
+  end
+
+end

data/test/sitra_client/sitra_response_test.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+gem 'shoulda'
+require 'test/unit'
+require 'shoulda'
+require 'sitra_client/sitra_response'
+
+
+class SitraResponseTest < Test::Unit::TestCase
+
+  setup do
+    @response = '{"apiKey":"dummy_key","siteWebExportIdV1":"dummy_identifier","first_key":"first_value","second_key":"second_value"}'
+  end
+
+  should 'store raw json response' do
+
+    sitra_response = SitraResponse.new
+    sitra_response.append_line(@response)
+
+    assert_equal @response, sitra_response.as_raw_json
+
+  end
+
+  should 'return response as hash' do
+
+    sitra_response = SitraResponse.new
+    sitra_response.append_line(@response)
+
+    response_hash = sitra_response.as_hash
+
+    assert_equal 'dummy_key',  response_hash[:apiKey]
+    assert_equal 'dummy_identifier',  response_hash[:siteWebExportIdV1]
+    assert_equal 'first_value',  response_hash[:first_key]
+    assert_equal 'second_value',  response_hash[:second_key]
+
+  end
+
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: sitra_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- jeanbaptistevilain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.14
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sitra Client Gem
+email:
+- jbvilain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sitra_client.rb
+- lib/sitra_client/attribute_helper.rb
+- lib/sitra_client/sitra_query.rb
+- lib/sitra_client/sitra_response.rb
+- lib/sitra_client/version.rb
+- sitra_client.gemspec
+- test/sitra_client/sitra_query_test.rb
+- test/sitra_client/sitra_response_test.rb
+homepage: ''
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+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