fiware-orion-geo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 713492ae3468b92dfdf6096f89cc92bcfad2e602
-  data.tar.gz: 550edceac9215673cca82a1e501f8d7b4d3271a3
+  metadata.gz: 1e0c615da80260fd517e1f4b8614ec017bfd60f5
+  data.tar.gz: 53f89816480b6cf7d7bfa059599d74a0ebc57921
 SHA512:
-  metadata.gz: 3259d2117cef22cc4127fcc43038d03a91dd419227ad3b09335ae20a6d0abfaa678017249240d401204799cd22c5dc2d0cbb6062319a11bb9b6479abeffc9273
-  data.tar.gz: c806c79835a57ecbd2673436fed671e89ce4127847914c5ca99f0f136600b369bc61ccb8a2007d57cbf9cf1f66b37b55023df4acef91acda1af3421895433949
+  metadata.gz: a781e93649a6b109a99d6523dd91d3156d6b6f25ee3d2a3a179fe3ed2cceb7526945a5e01cee597bb5155eda5828ecb85c25a71a4200f42f9ff24390b30bb4c0
+  data.tar.gz: 3e979fae91642efa440b1ea0f7f667f18b29406ef4c5e3db74eef2caf3d83f9ea184372507b01108085810a06a250dbb325f19e8817af44c4030eb180c3e0f07

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/LICENSE

@@ -0,0 +1,20 @@
+he MIT License (MIT)
+
+Copyright (c) 2015 Nikolaï POSNER
+
+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,56 @@
+# fiware-orion-geo
+Interface to dialog with Orion server from Fiware (Geolocalization)
+
+# Config
+
+Dependencies:
+  HTTPParty - https://rubygems.org/gems/httparty
+
+To configure the gem create the file config/initializers/fiware_orion_config.rb and add the configuration of the client.
+
+Example:
+
+```ruby
+Rails.application.config.after_initialize do
+  ORION_SERVER_IP = {Your Orion server address} unless defined?(ORION_SERVER_IP)
+
+  Orion::Config.load_config(ORION_SERVER_IP)
+end
+```
+
+# Installation
+
+Add to your Gemfile:
+
+`gem 'qq_client'`
+
+Then bundle install
+
+Or install it yourself as:
+
+`$ gem install qq_client`
+
+# Usage
+
+* type = type of object stored E.g:'Cars', 'Houses', 'Fruits'... - String
+* id = identifier of the object - String
+* type_area = can be 'polygon' or 'circle' - String
+  * circle: array_point = ['lat', 'long', 'radius'] ----- radius in meters 
+  * polygon: array_point = ['lat, long','lat, long','lat, long'] ----- infinite number of points
+
+
+`Orion::Geo.new`
+
+INSERT
+`def push(type, id, long, lat)`
+
+SELECT
+`def pull(type, type_area, array_point)`
+
+DELETE
+`def delete(type, id)`
+
+UPDATE = To update you have to delete the object then create a new one (REF: Fiware documentation)
+
+
+# Contributing

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :spec

data/fiware-orion-geo.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'fiware-orion-geo'
+  s.version     = '0.0.2'
+  s.date        = '2014-08-03'
+  s.summary     = "Interface for Orion server"
+  s.description = "Gives you the possibility to simply interfear with Orion server (from Fiware) to insert and retreive data based on geolocalisation"
+  s.authors     = ["Nikolaï POSNER"]
+  s.email       = 'nikoposner@gmail.com'
+  s.files       = `git ls-files`.split($\)
+  s.homepage    = 'http://rubygems.org/gems/fiware-orion-geo'
+  s.license     = 'MIT'
+
+  s.add_development_dependency 'rspec', '~> 0'
+  s.add_runtime_dependency 'httparty', '~> 0'
+end

data/lib/fiware-orion-geo.rb

@@ -1,5 +1,2 @@
-class FiwareOrionGeo
-  def self.test
-    puts 'test'
-  end
-end
+require 'orion/geo/geo'
+require 'orion/config'

data/lib/orion/config.rb

@@ -0,0 +1,43 @@
+# -*- encoding : utf-8 -*-
+module Orion
+  module Config
+
+    class << self
+      attr_reader :orion_url
+
+      def load_config(orion_url)
+        begin
+          filename = "/config/initializers/fiware_orion_config.rb"
+          # filename = "#{Rails.root}/config/initializers/fiware_orion_config.rb"
+          if self.check_config_file(filename)
+            require filename
+            @orion_url = (orion_url.nil?) ? ORION_SERVER_IP : orion_url
+          else
+            @orion_url = orion_url
+            puts @orion_url
+          end
+          {
+              orion_url: @orion_url,
+          }
+        rescue => e
+          puts e => e.message
+        end
+      end
+
+      def check_config_file(filename)
+        result = true
+        unless File.exist?(filename)
+          puts "|>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+          puts "|"
+          puts "Please configure orion_url in #{filename}."
+          puts "|"
+          puts "|>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>"
+          result = false
+        end
+        result
+      end
+    end
+
+
+  end
+end

data/lib/orion/geo/geo.rb

@@ -0,0 +1,132 @@
+require 'httparty'
+require 'pp'
+
+module Orion
+  class Geo
+
+    def initialize
+      config = Orion::Config::load_config('http://192.168.99.100:32769')
+      @url = config[:orion_url]
+    end
+
+    # type = type of data E.g: 'City'
+    # id = id of the element
+    # long = Longitude
+    # lat = latitude
+    def push(type,id,long,lat)
+      action = '/ngsi10/updateContext'
+
+      options = {
+          body: {
+              contextElements: [
+                {
+                  type: type,
+                  isPattern: "false",
+                  id: id,
+                  attributes: [
+                  {
+                    name: "position",
+                    type: "coords",
+                    value: "#{lat}, #{long}",
+                    metadatas: [
+                      {
+                        name: "location",
+                        type: "string",
+                        value: "WSG84"
+                      }
+                    ]
+                  }
+                ]
+              }
+              ],
+              updateAction: "APPEND"
+            }.to_json,
+          headers: { 'Content-Type' => 'application/json' }
+          }
+
+      HTTParty.post(@url + action, options)
+    end
+
+    # type = type of data E.g: 'City'
+    # type_area = 'circle' || 'polygon'
+    #   - polygon: array_point = ['lat, long','lat, long','lat, long'] ----- infinite number of points
+    #   - circle: array_point = ['lat, long, radius'] ----- radius in meters
+    def pull(type, type_area, array_point)
+      action = '/ngsi10/queryContext'
+
+      options = {
+          body: {
+          entities: [
+            {
+              type: type,
+              isPattern: "true",
+              id: ".*"
+            }
+          ],
+          restriction: {
+            scopes: [
+              {
+                type: "FIWARE::Location",
+                value: get_area(type_area, array_point)
+              }
+            ]
+          }
+        }.to_json,
+        headers: { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+      }
+
+      HTTParty.post(@url + action, options)
+    end
+
+    # type = type of data E.g: 'City'
+    # id = id of the object
+    def delete(type, id)
+      action = '/ngsi10/updateContext'
+
+      options = {
+        body: {
+          contextElements: [
+            {
+              type: type,
+              isPattern: "false",
+              id: id
+            }
+          ]
+        }.to_json,
+        headers: { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }
+      }
+
+      HTTParty.post(@url + action, options)
+    end
+
+    # type_area = 'circle' || 'polygon'
+    #   - polygon: array_point = ['lat, long','lat, long','lat, long'] ----- infinite number of points
+    #   - polygon: array_point = [lat, long, radius] ----- radius in meters
+    private
+    def get_area(type_area, array_point)
+      if type_area == 'circle'
+        area = {
+            circle: {
+                centerLatitude: array_point[0],
+                centerLongitude: array_point[1],
+                radius: array_point[2]
+            }
+        }
+      else
+        area = {
+            polygon: {
+                vertices:
+                array_point.map{ |c|
+                  c = c.split(',')
+                  {
+                      latitude: c[0],
+                      longitude: c[1]
+                  }
+                }
+            }
+        }
+      end
+      area
+    end
+  end
+end

data/spec/fiware_orion_geo_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe 'Endpoints Orion server' do
+
+  before(:each) do
+    @sut = Orion::Geo.new
+  end
+
+  describe 'Store geolocalisation data for object' do
+
+    context 'build a area' do
+      it 'should return circle' do
+        actual = @sut.instance_eval{get_area('circle', [2,3,2])}
+        expected = {circle: {centerLatitude: 2, centerLongitude: 3, radius: 2}}
+        expect(actual).to eq(expected)
+      end
+
+      it 'should return a polygon' do
+        actual = @sut.instance_eval{get_area('polygon', ['1,2','4,5','3,2'])}
+        expected = {polygon: {vertices: [{ latitude: '1', longitude: '2' }, { latitude: '4', longitude: '5' },{ latitude: '3', longitude: '2'}]}}
+        expect(actual).to eq(expected)
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'fiware-orion-geo'
+
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiware-orion-geo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nikolaï POSNER
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2014-08-03 00:00:00.000000000 Z
 dependencies:
+- !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'
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -25,13 +39,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Gives you the possibility to simply interfear with Orion server (from
-  Inpact) to insert and retreive data based on geolocalisation
+  Fiware) to insert and retreive data based on geolocalisation
 email: nikoposner@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- LICENSE
+- README.md
+- Rakefile
+- fiware-orion-geo.gemspec
 - lib/fiware-orion-geo.rb
+- lib/orion/config.rb
+- lib/orion/geo/geo.rb
+- spec/fiware_orion_geo_spec.rb
+- spec/spec_helper.rb
 homepage: http://rubygems.org/gems/fiware-orion-geo
 licenses:
 - MIT