fc2json 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e40ed0ee6914ba7f03f52603b94dfc7f4f0b430
-  data.tar.gz: e3d0c184cc995e5197acd0d7fa69f1d2eafa803f
+  metadata.gz: 06c7d8b4284506adff00d95b7ca56aa0827b786f
+  data.tar.gz: 7236fc2320b8e6b0ca3b5e4d4e2a02dbd08048af
 SHA512:
-  metadata.gz: e0f253865ab0212168ed90dce50cbcb1fb3573ee18eb89fb5eab8d0ec75beaf1f6eed3add623066715bd9f3a77fec26069685db4af23d3db35f7146e49ed6771
-  data.tar.gz: 0387251b1aca6c4e95f09f6eee1497b00fc8d49dc7de4b42b2a4c803c1f8ba0618c7f439c11700d760e10ef2ba70c9ebce51f4da2aa5f5b9c1ce3194daaeb0f5
+  metadata.gz: 7d59432dfbe6650042149cf5917e5a2e4263ee6e13f83e9939e7ff10f95ed6a3e38bcc63283c6ad43c149cbd35f4bec21837413aea246f4a425c68361e215deb
+  data.tar.gz: 5318473b30f5608aa2f7d99f6dce7c249b1c4ac966400ba15f97bad9537d113c02d0033bbbc4f126b45ff013c2a41786b9da102731d13451ee2f9f1ac890dea2

data/Gemfile

@@ -1,5 +1,5 @@
 source "http://rubygems.org"
-gem 'nokogiri', "~> 1.5.10"
+gem 'nokogiri', "~> 1.5", ">= 1.5.10"
 
 group :development, :test do
   gem "rspec", "~> 2.8", ">= 2.8.0"

data/Gemfile.lock

@@ -66,7 +66,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.0)
   jeweler (~> 1.8, >= 1.8.7)
-  nokogiri (~> 1.5.10)
+  nokogiri (~> 1.5, >= 1.5.10)
   rspec (~> 2.8, >= 2.8.0)
   vcr (~> 2.8, >= 2.8.0)
   webmock (~> 1.15, < 1.16.0)

data/README.md

@@ -0,0 +1,53 @@
+fc2json
+==================
+
+When querying a esri feature service to get all data published through it, it is needed to deal with the limitation on the number
+of records returned by the server. fc2json abstracts the tasks needed to get all data from a esri feature service.
+
+###Usage
+
+Install the gem as usual:
+
+```ruby
+gem install fc2json
+```
+
+Create an instance of a FC2Json object, passing it the service url as a parameter. After creating the instance, just call the get method on it to get a json object with all the data exposed by the service. The following code presents a sample on downloading and saving the service data to a file:
+
+```ruby
+File.open("output.json", 'w') do |file|
+	file.write FC2Json.new("http://services2.arcgis.com/hMIIIBIOpi8Cdgjw/arcgis/rest/services/ubs/FeatureServer/0").get
+end
+```
+
+####Initialization parameters
+
+The constructor of a FC2Json object is declares as follows:
+
+```ruby
+def initialize (service_url, object_identifier_field_name = nil, records_per_request = nil, where_clause = nil)
+end
+```
+
+The construction parameters are:
+
+* __service_url:__ Mandatory. The url for the feature service. 
+* __object_identifier_field_name:__ Optional. The name of the field used as an object identifier on the feature service. If not provided, defaults to "FID"
+* __records_per_request:__ Optional. The number of records returned on each request to the service. Be aware that if you specify a number greater than the max number of records configured on the service, an ArgumentError will be raised. If not provided, defaults to 2000.
+* __where_clause:__ Optional. The where condition (SQL query) to filter the records on the feature service. If not provided, defaults to "1 = 1"
+
+###Contributing to fc2json
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+###Copyright
+
+Copyright (c) 2013 rpepato. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/fc2json

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fc2json'
+print FC2Json.new(*ARGV).get

data/fc2json.gemspec

@@ -2,21 +2,22 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: fc2json 0.1.0 ruby lib
+# stub: fc2json 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "fc2json"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Roberto Pepato"]
-  s.date = "2013-12-30"
+  s.date = "2013-12-31"
   s.description = "fc2json queries, downloads and formats all data from a remote Esri feature service, exposing it as json representation"
   s.email = "rpepato@gmail.com"
+  s.executables = ["fc2json"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -24,9 +25,10 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
+    "bin/fc2json",
     "fc2json.gemspec",
     "lib/fc2json.rb",
     "spec/fc2json_spec.rb",
@@ -47,18 +49,18 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.5.10"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 1.5.10", "~> 1.5"])
       s.add_development_dependency(%q<rspec>, [">= 2.8.0", "~> 2.8"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, [">= 1.8.7", "~> 1.8"])
     else
-      s.add_dependency(%q<nokogiri>, ["~> 1.5.10"])
+      s.add_dependency(%q<nokogiri>, [">= 1.5.10", "~> 1.5"])
       s.add_dependency(%q<rspec>, [">= 2.8.0", "~> 2.8"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, [">= 1.8.7", "~> 1.8"])
     end
   else
-    s.add_dependency(%q<nokogiri>, ["~> 1.5.10"])
+    s.add_dependency(%q<nokogiri>, [">= 1.5.10", "~> 1.5"])
     s.add_dependency(%q<rspec>, [">= 2.8.0", "~> 2.8"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, [">= 1.8.7", "~> 1.8"])

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: fc2json
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Roberto Pepato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-30 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.10
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.10
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,20 +87,22 @@ dependencies:
 description: fc2json queries, downloads and formats all data from a remote Esri feature
   service, exposing it as json representation
 email: rpepato@gmail.com
-executables: []
+executables:
+- fc2json
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - ".document"
 - ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
+- bin/fc2json
 - fc2json.gemspec
 - lib/fc2json.rb
 - spec/fc2json_spec.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= fc2json
-
-Description goes here.
-
-== Contributing to fc2json
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2013 rpepato. See LICENSE.txt for
-further details.
-