simple-mappr 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16967f26e4668195844c0caf0f38ad08aa3684e3
+  data.tar.gz: 274d9f9d3176d9945d8065379cbb8a4ca78c0d12
+SHA512:
+  metadata.gz: 4f131d8b9cdd3521b3237a41e14bb970054068d62f9a388cc2dd1e6e183e845c3f4bf7552f0650d849c3a39878c2fb4e4fac0d1e7b5554ae82ec8a807e6d29bb
+  data.tar.gz: 305a60041b79e4269dfd60e69648316cf36c0edfc366dc78180ab0e1a1d00306fbf3bf824ea39847e41561cbd45efbebb3b000f78662317a223d03ab3a9b20af

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 David P. Shorthouse
+
+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/lib/simple-mappr.rb

@@ -0,0 +1,378 @@
+require "simple-mappr/constants"
+require "simple-mappr/exceptions"
+require "simple-mappr/transporter"
+require "simple-mappr/validator"
+
+class SimpleMappr
+
+  def initialize
+    @parameters = {}
+  end
+
+  ##
+  # View the built parameters
+  #
+  def params
+    @parameters
+  end
+
+  ##
+  # Check if the RESTful API is alive and well
+  #
+  def alive?
+    response = Transporter.ping
+    response[:status] == "ok"
+  end
+
+  ##
+  # Send the SimpleMappr object to the RESTful API
+  # and receive a Hash in return containing
+  # a URL to the image and its expected expiry
+  #
+  # == Example Output
+  #
+  #   {
+  #     imageURL: "http://img.simplemappr.local/579273e6_1dd1_2.png",
+  #      expiry: "2016-07-22T21:28:38-04:00"
+  #   }
+  #
+  def create
+    Transporter.send_data @parameters
+  end
+
+  ##
+  # Set a bounding box in decimal degrees as minx,miny,maxx,maxy
+  #
+  # == Example
+  #
+  #   instance.bbox = "-120,45,-100,52"
+  #
+  def bbox=(bbox)
+    Validator.validate_bbox(bbox)
+    @parameters[:bbox] = bbox
+  end
+
+  def bbox
+    @parameters[:bbox] || nil
+  end
+
+  ##
+  # Set the colors in rgb corresponding to the points
+  #
+  # == Example
+  #
+  #   instance.color = ["255,0,0","0,255,0"]
+  #
+  def color=(color)
+    Validator.validate_colors(color)
+    @parameters[:color] = color
+  end
+
+  def color
+    @parameters[:color] || nil
+  end
+
+  ##
+  # Set a file path for a csv or tab-separated text file
+  #
+  # == Example
+  #
+  #   instance.file = "/Users/SimpleMappr/demo.txt"
+  #
+  def file_path=(file_path)
+    Validator.validate_type(file_path, 'File')
+    @parameters[:file] = File.new(file_path, "r")
+  end
+
+  def file_path
+    @parameters[:file].path rescue nil
+  end
+
+  ##
+  # Turn on or off the graticules (grid)
+  #
+  # == Example
+  #
+  #   instance.graticules = true
+  #
+  def graticules=(graticules)
+    Validator.validate_type(graticules, 'Boolean')
+    @parameters[:graticules] = graticules
+  end
+
+  def graticules
+    @parameters[:graticules] || nil
+  end
+
+  ##
+  # Specify the height of the image in pixels
+  # Maximum value is 4500
+  #
+  # == Example
+  #
+  #   instance.height = 1_000
+  #
+  def height=(height)
+    Validator.validate_dimension(height)
+    @parameters[:height] = height
+  end
+
+  def height
+    @parameters[:height] || nil
+  end
+
+  ##
+  # Specify the layers to include in the image
+  # Expressed as a comma-separated String without spaces
+  # See SimpleMappr.layers
+  #
+  # == Example
+  #
+  #   instance.layers = 'oceans,lakes,rivers'
+  #
+  def layers=(layers)
+    Validator.validate_layers(layers)
+    @parameters[:layers] = layers
+  end
+
+  def layers
+    @parameters[:layers] || nil
+  end
+
+  ##
+  # Specify the legend title(s)
+  # Expressed as an array of Strings corresponding to the points
+  #
+  # == Example
+  #
+  #   instance.layers = ['My First Legend','My Second Legend']
+  #
+  def legend=(legend)
+    Validator.validate_type(legend, 'Array')
+    @parameters[:legend] = legend
+  end
+
+  def legend
+    @parameters[:legend] || nil
+  end
+
+  ##
+  # Specify the origin of natural longitude
+  #
+  # == Example
+  #
+  #   instance.origin = -100
+  #
+  def origin=(origin)
+    Validator.validate_origin(origin)
+    @parameters[:origin] = origin
+  end
+
+  def origin
+    @parameters[:origin] || nil
+  end
+
+  ##
+  # Specify the color in rgb for the outline around all points
+  #
+  # == Example
+  #
+  #   instance.outlinecolor = "10,10,10"
+  #
+  def outlinecolor=(outlinecolor)
+    Validator.validate_color(outlinecolor)
+    @parameters[:outlinecolor] = outlinecolor
+  end
+
+  def outlinecolor
+    @parameters[:outlinecolor] || nil
+  end
+
+  ##
+  # Specify the output file format
+  # Options are svg, png, or jpg
+  #
+  # == Example
+  #
+  #   instance.output = "png"
+  #
+  def output=(output)
+    Validator.validate_output(output)
+    @parameters[:output] = output
+  end
+
+  def output
+    @parameters[:output] || nil
+  end
+
+  ##
+  # An array of geographic coordinates, each as latitude,longitude
+  # Group coordinates in array elements, each of which can also be 
+  # separated by linebreaks, \n
+  #
+  # == Example
+  #
+  #   instance.points = ["45,-120\n45.4,-110","52,-120"]
+  #
+  def points=(points)
+    Validator.validate_points(points)
+    @parameters[:points] = points
+  end
+
+  def points
+    @parameters[:points] || nil
+  end
+
+  ##
+  # Specify the projection
+  # See simple-mappr/constants.rb
+  #
+  # == Example
+  #
+  #   instance.projection = "epsg:4326"
+  #
+  def projection=(projection)
+    Validator.validate_projection(projection)
+    @parameters[:projection] = projection
+  end
+
+  def projection
+    @parameters[:projection] || nil
+  end
+
+  ##
+  # Include an embedded scalebar
+  #
+  # == Example
+  #
+  #   instance.scalebar = true
+  #
+  def scalebar=(scalebar)
+    Validator.validate_type(scalebar, 'Boolean')
+    @parameters[:scalebar] = scalebar
+  end
+
+  def scalebar
+    @parameters[:scalebar] || nil
+  end
+
+  ##
+  # Include shaded regions as a Hash
+  # Specify color, title, and places as keys
+  #
+  # == Example
+  #
+  #   instance.shade = { color: "200,200,200", title: "My Regions", places: "Canada,US[WY|WA]"}
+  #
+  def shade=(shade)
+    Validator.validate_shade(shade)
+    @parameters[:shade] = shade
+  end
+
+  def shade
+    @parameters[:shade] || nil
+  end
+
+  ##
+  # Describe the shape to use corresponding to the points
+  # See simple-mappr/constants.rb
+  #
+  # == Example
+  #
+  #   instance.shape = ['circle','square']
+  #
+  def shape=(shape)
+    Validator.validate_shapes(shape)
+    @parameters[:shape] = shape
+  end
+
+  def shape
+    @parameters[:shape] || nil
+  end
+
+  ##
+  # Specify the size of the corresponding points
+  # Options are Integer less than or equal to 14
+  #
+  # == Example
+  #
+  #   instance.size = [8,14]
+  #
+  def size=(size)
+    Validator.validate_sizes(size)
+    @parameters[:size] = size
+  end
+
+  def size
+    @parameters[:size] || nil
+  end
+
+  ##
+  # Specify the spacing between graticule (grid) lines in degrees
+  # Must be an Integer less than or equal to 10
+  #
+  # == Example
+  #
+  #   instance.spacing = 5
+  #
+  def spacing=(spacing)
+    Validator.validate_spacing(spacing)
+    @parameters[:spacing] = spacing
+  end
+
+  def spacing
+    @parameters[:spacing] || nil
+  end
+
+  ##
+  # Specify a remote URL
+  # Source must be a csv, a tab-delimited file, or a GeoRSS
+  #
+  # == Example
+  #
+  #   instance.url = "http://www.simplemappr.net/public/files/demo.csv"
+  #
+  def url=(url)
+    Validator.validate_url(url)
+    @parameters[:url] = url
+  end
+
+  def url
+    @parameters[:url] || nil
+  end
+
+  ##
+  # Specify the width of the output in pixels
+  # Must be less than or eqaual to 4500
+  #
+  # == Example
+  #
+  #   instance.width = 1_000
+  #
+  def width=(width)
+    Validator.validate_dimension(width)
+    @parameters[:width] = width
+  end
+
+  def width
+    @parameters[:width] || nil
+  end
+
+  ##
+  # Specify a zoom level, centred on the geographic center of all points
+  # Must be less than or eqaual to 10
+  #
+  # == Example
+  #
+  #   instance.zoom = 3
+  #
+  def zoom=(zoom)
+    Validator.validate_zoom(zoom)
+    @parameters[:zoom] = zoom
+  end
+
+  def zoom
+    @parameters[:zoom] || nil
+  end
+
+end

data/lib/simple-mappr/constants.rb

@@ -0,0 +1,80 @@
+class SimpleMappr
+
+  API_URL = "http://www.simplemappr.net/api/"
+
+  PROJECTIONS = [
+    'epsg:4326',
+    'esri:102009',
+    'esri:102015',
+    'esri:102014',
+    'esri:102012',
+    'esri:102024',
+    'epsg:3112',
+    'epsg:102017',
+    'epsg:102019'
+  ]
+
+  SHAPES = [
+    'plus',
+    'cross',
+    'asterisk',
+    'circle',
+    'square',
+    'triangle',
+    'inversetriangle',
+    'star',
+    'hexagon',
+    'opencircle',
+    'opensquare',
+    'opentriangle',
+    'inverseopentriangle',
+    'openstar',
+    'openhexagon'
+  ]
+
+  LAYERS = [
+    'countries',
+    'countrynames',
+    'relief',
+    'reliefgrey',
+    'stateprovinces',
+    'stateprovnames',
+    'lakes',
+    'lakesOutline',
+    'lakenames',
+    'rivers',
+    'rivernames',
+    'oceans',
+    'marineLabels',
+    'placenames',
+    'physicalLabels',
+    'ecoregions',
+    'ecoregionLabels',
+    'conservation',
+    'hotspotLabels',
+    'blueMarble'
+  ]
+
+  OUTPUTS = ['svg', 'png', 'jpg']
+
+  def self.api_url
+    API_URL
+  end
+
+  def self.shapes
+    SHAPES
+  end
+
+  def self.projections
+    PROJECTIONS
+  end
+
+  def self.layers
+    LAYERS
+  end
+
+  def self.outputs
+    OUTPUTS
+  end
+
+end

data/lib/simple-mappr/exceptions.rb

@@ -0,0 +1,3 @@
+class SimpleMappr
+  class InvalidParameterValue < ArgumentError; end
+end

data/lib/simple-mappr/transporter.rb

@@ -0,0 +1,21 @@
+require "rest_client"
+require "json"
+require "simple-mappr/validator"
+
+class SimpleMappr
+  class Transporter
+
+    def self.send_data params
+      Validator.validate_type(params, 'Hash')
+      params.delete_if{ |k,v| !v }
+      RestClient.post(API_URL, params) do |response, request, result, &block|
+        JSON.parse(response.body, :symbolize_names => true)
+      end
+    end
+
+    def self.ping
+      send_data({ ping: true })
+    end
+
+  end
+end

data/lib/simple-mappr/validator.rb

@@ -0,0 +1,146 @@
+require "uri"
+
+class SimpleMappr
+  class Validator
+
+    def self.validate_bbox(data)
+      validate_type(data, 'String')
+      coords = data.split(",")
+      if coords.length != 4
+        raise InvalidParameterValue, "bbox must have four parameters in the form -110,45,-100,52"
+      end
+      validate_coordinate(coords[1].to_f, coords[0].to_f)
+      validate_coordinate(coords[3].to_f, coords[2].to_f)
+    end
+
+    def self.validate_coordinate(latitude, longitude)
+      if latitude > 90 || latitude < -90 || longitude > 180 || longitude < -180
+        raise InvalidParameterValue, "Coordinate latitude,longitude=#{latitude},#{longitude} is not valid"
+      end
+    end
+
+    def self.validate_colors(data)
+      validate_type(data, 'Array')
+      data.each { |item| validate_color(item) }
+    end
+
+    def self.validate_color(data)
+      validate_type(data, 'String')
+      rgb = data.split(",")
+      if rgb.length != 3
+        raise InvalidParameterValue, "color must have three parameters in the form 0,0,0"
+      end
+      rgb.each do |item|
+        begin
+          Integer(item || '')
+        rescue ArgumentError
+          raise InvalidParameterValue, "color value must be an integer <= 255"
+        end
+        if item.to_i > 255
+          raise InvalidParameterValue, "color value must be an integer <= 255"
+        end
+      end
+    end
+
+    def self.validate_dimension(data)
+      validate_type(data, 'Integer')
+      if data > 4_500
+        raise InvalidParameterValue, "Accepted integer values are <= 4500"
+      end
+    end
+
+    def self.validate_points(data)
+      validate_type(data, 'Array')
+      data.each { |item| validate_type(item, 'String') }
+    end
+
+    def self.validate_shapes(data)
+      validate_type(data, 'Array')
+      data.each do |item|
+        if !SHAPES.include?(item)
+          raise InvalidParameterValue, "Values must each be one of #{SHAPES.join(", ")}"
+        end
+      end
+    end
+
+    def self.validate_sizes(data)
+      validate_type(data, 'Array')
+      data.each do |item|
+        validate_type(item, 'Integer')
+        if item > 14
+          raise InvalidParameterValue, "Values must each be integers less than 14"
+        end
+      end
+    end
+
+    def self.validate_url(data)
+      validate_type(data, 'String')
+      if data !~ /\A#{URI::regexp(['http', 'https'])}\z/
+        raise InvalidParameterValue, "URL must be in the form http:// or https://"
+      end
+    end
+
+    def self.validate_zoom(data)
+      validate_type(data, 'Integer')
+      if data > 10
+        raise InvalidParameterValue, "Accepted integer value is <= 10"
+      end
+    end
+
+    def self.validate_shade(data)
+      validate_type(data, 'Hash')
+      data = data.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      if !(data.keys - [:places, :title, :color]).empty?
+        raise InvalidParameterValue, "Shade must be Hash in the form { places: \"\", title: \"\", color: \"\" }"
+      end
+      if data.key?(:color)
+        validate_color(data[:color])
+      end
+    end
+
+    def self.validate_layers(data)
+      validate_type(data, 'String')
+      if !(data.split(",") - LAYERS).empty?
+        raise InvalidParameterValue, "Accepted layers are combinations of #{LAYERS.join(", ")}"
+      end
+    end
+
+    def self.validate_projection(data)
+      if !PROJECTIONS.include?(data)
+        raise InvalidParameterValue, "Accepted projection values are #{PROJECTIONS.join(", ")}"
+      end
+    end
+
+    def self.validate_origin(data)
+      validate_type(data, 'Integer')
+      if data > 180 || data < -180
+        raise InvalidParameterValue, "Accepted integer values are -180 <= x <= 180"
+      end
+    end
+
+    def self.validate_spacing(data)
+      validate_type(data, 'Integer')
+      if data > 10
+        raise InvalidParameterValue, "Accepted integer values are <= 10"
+      end
+    end
+
+    def self.validate_output(data)
+      if !OUTPUTS.include?(data)
+        raise InvalidParameterValue, "Accepted outputs are #{OUTPUTS.join(", ")}"
+      end
+    end
+
+    def self.validate_type(data, type)
+      case type
+      when 'String', 'Array', 'Integer', 'Hash'
+        raise InvalidParameterValue, "Must be a #{type}" unless data.is_a?(Object.const_get(type))
+      when 'Boolean'
+        raise InvalidParameterValue, "Must be a Boolean" unless [true, false].include?(data)
+      when 'File'
+        raise InvalidParameterValue, "Must be a file path & file must exist" unless File.file?(data)
+      end
+    end
+
+  end
+end

data/lib/simple-mappr/version.rb

@@ -0,0 +1,7 @@
+class SimpleMappr
+  VERSION = "0.0.1"
+
+  def self.version
+    VERSION
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: simple-mappr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David P. Shorthouse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+description: A gem to access the SimpleMappr API
+email: 'davidpshorthouse@gmail.com '
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/simple-mappr.rb
+- lib/simple-mappr/constants.rb
+- lib/simple-mappr/exceptions.rb
+- lib/simple-mappr/transporter.rb
+- lib/simple-mappr/validator.rb
+- lib/simple-mappr/version.rb
+homepage: https://github.com/dshorthouse/simple-mappr
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--encoding"
+- UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem to access the SimpleMappr API
+test_files: []