citysdk 0.1.2.5 → 1.0

data/citysdk.gemspec

@@ -19,11 +19,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   
-  gem.add_dependency('dbf')
-  gem.add_dependency('georuby', '>= 2.0.0')
-  gem.add_dependency('faraday', '>= 0.8.5')
-  gem.add_dependency('charlock_holmes', '>= 0.6.9.4')
+  gem.add_dependency('dbf', '~> 2.0')
+  gem.add_dependency('georuby', '~> 2.0')
+  gem.add_dependency('faraday', '~> 0.8')
+  gem.add_dependency('charlock_holmes', '~> 0.6')
+  gem.add_dependency('curses', '~> 1.0')
   
-  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec", '~> 3.0'
 end
 

data/examples/simple_api.rb

@@ -0,0 +1,68 @@
+#!/usr/bin/env ruby
+
+# check the wiki for detailed api usage: https://github.com/waagsociety/citysdk-ld/wiki
+
+require 'citysdk'
+include CitySDK
+
+api = API.new('api.citysdk.waag.org') # point to a hosted instance of the api.
+
+# simple GET
+# GET requests do not need authentication
+
+endpoint = api.get '/'
+puts "Enpoint is: #{endpoint[:features][0][:properties][:title]}."
+
+first10layers = api.get('/layers')
+puts "First layer: #{JSON.pretty_generate(first10layers[:features][0])}"
+
+# find out how many owners the endpoint knows
+owners = api.get('/owners?per_page=1&count')
+puts "Number of data maintaners: #{api.last_result[:headers]['x-result-count']}"
+
+# authenticate for write actions.
+unless api.authenticate('<name>','<passw>')
+  puts "Did not authenticate..."
+  exit 
+end
+  
+# make a layer
+# everybody can wite to the temporary 'test' domain: 
+
+layer = {
+  name: "test.cities",
+  owner: "citysdk",
+  title: "Cities: 🏠🏢🏣🏨🏫🏬🏭🏡",
+  description: "Cities big and small.",
+  data_sources: [ "http://fantasy.com" ],
+  authoritative: false,
+  rdf_type: "dbp:City",
+  category: "administrative",
+  subcategory: "cities",
+  licence: "CC0"
+}
+
+api.post('/layers',layer)
+
+  # add data to this layer
+  # attach to the node representing the city of Rotterdam
+object = {type: "Feature", 
+          geometry: {
+            type: 'Point',
+            coordinates: [4.4646,51.9222] }, 
+            properties: {
+              id: 'Rotterdam', 
+              title: 'Rotterdam', 
+              data: {
+                a: 1, 
+                b: 2
+              }
+            }
+         }
+  
+api.post('/layers/test.cities/objects', object)
+
+
+# don't forget to release! this will also send 'unfilled' batches to the backend.
+api.release
+

data/lib/citysdk/api.rb

@@ -1,61 +1,62 @@
 require 'json'
 require 'faraday'
 
+
+
 module CitySDK
+
+  def log(m)
+    File.open(File.expand_path('~/csdk.log'), "a")  do |f|
+      f.write(m + "\n")
+    end
+  end
   
   class HostException < ::Exception
   end
 
   class API
-    attr_reader :error
+    attr_reader   :last_result
+    attr_reader   :error
     attr_accessor :batch_size
-  
-    @@match_tpl = {
-      :match => {
-        :params => {}
-      },
-      :nodes => []
-    }
+    attr_accessor :page_size
+    attr_accessor :format
+
     @@create_tpl =  {
-      :create => {
-        :params => {
-          :create_type => "create"
-        }
-      },
-      :nodes => []
+      type: "FeatureCollection",
+      features: []
     }
 
     def initialize(host, port=nil)
       @error = '';
       @layer = '';
-      @batch_size = 10;
+      @batch_size = 1000;
+      @page_size = 25;
+      @format = 'jsonld'
       @updated = @created = 0;
       set_host(host,port)
     end
     
-    def authenticate(e,p)
-      @email = e;
+    def authenticate(n,p)
+      @name = n;
       @passw = p;
-      if !( @host == 'api.dev' or @host == 'localhost' or @host == '127.0.0.1' or @host == '0.0.0.0')
-        auth_connection = Faraday.new :url => "https://#{@host}", :ssl => {:verify => false}
-        resp = auth_connection.get '/get_session', { :e => @email, :p => @passw }
-      else 
-        resp = @connection.get '/get_session', { :e => @email, :p => @passw }
-      end
-      if resp.status == 200 
+
+      resp = @connection.get '/session', { :name => @name, :password => @passw }
+      if resp.status.between?(200, 299) 
         resp = CitySDK::parseJson(resp.body)
-        if resp[:status] == 'success'
-          @connection.headers['X-Auth'] = resp[:results][0]
+        if (resp.class == Hash) and resp[:session_key]
+          @connection.headers['X-Auth'] = resp[:session_key]
         else
-          raise Exception.new(resp[:message])
+          raise Exception.new("Invalid credentials")
         end
       else
         raise Exception.new(resp.body)
       end
-      
       if block_given?
-        yield
-        return self.release
+        begin
+          yield
+        ensure
+          self.release
+        end
       end
       true
     end
@@ -64,6 +65,8 @@ module CitySDK
       @host = host
       @port = port
       
+      @host.gsub!(/^http(s)?:\/\//,'')
+
       if port.nil?
         if host =~ /^(.*):(\d+)$/
           @port = $2
@@ -73,7 +76,11 @@ module CitySDK
         end
       end
       
-      @connection = Faraday.new :url => "http://#{@host}:#{@port}"
+      if !($nohttps or @host =~ /.+\.dev/ or @host == 'localhost' or @host == '127.0.0.1' or @host == '0.0.0.0')
+        @connection = Faraday.new :url => "https://#{@host}", :ssl => {:verify => false }
+      else
+        @connection = Faraday.new :url => "http://#{@host}:#{@port}"
+      end
       @connection.headers = {
         :user_agent => 'CitySDK_API GEM ' + CitySDK::VERSION,
         :content_type => 'application/json'
@@ -84,16 +91,18 @@ module CitySDK
         raise CitySDK::Exception.new("Trouble connecting to api @ #{host}")
       end
       @create = @@create_tpl
-      @match = @@match_tpl
     end
-
-    def set_matchTemplate(mtpl) 
-      mtpl[:nodes] = []
-      @match = @@match_tpl = mtpl
+    
+    def addFormat(path)
+      if path !~ /format/
+        path = path + ((path =~ /\?/) ? "&" : "?") + "format=#{@format}"
+      end
+      return path if path =~ /page_size/
+      path + "&page_size=#{@page_size}"
     end
 
     def set_createTemplate(ctpl) 
-      ctpl[:nodes] = []
+      ctpl[:features] = []
       @create = @@create_tpl = ctpl
     end
 
@@ -101,123 +110,114 @@ module CitySDK
       @layer = l
     end
   
-    def set_layer_status(status)
-      put("/layer/#{@layer}/status",{:data => status})
+    def next
+      @next ? get(@next) : "{}"
     end
-  
-    def match_node(n)
-      @match[:nodes] << n
-      return match_flush if @match[:nodes].length >= @batch_size
-      return nil
+
+    def layers
+      get "/layers"
+    end
+
+    def owners
+      get "/owners"
     end
 
-    def match_create_node(n)
-      @match[:nodes] << n
-      return match_create_flush if @match[:nodes].length >= @batch_size
+    def objects(layer=nil)
+      !!layer ? get("/layers/#{layer}/objects") : get("/objects")
     end
 
-    def create_node(n)
-      @create[:nodes] << n
-      create_flush if @create[:nodes].length >= @batch_size
+    def create_object(n)
+      @create[:features] << n
+      create_flush if @create[:features].length >= @batch_size
     end
   
     def authorized?
-      @connection.headers['X-Auth']
+     !! @connection.headers['X-Auth'] 
     end
 
     def release
-      match_flush
       create_flush # send any remaining entries in the create buffer
-      match_create_flush
       if authorized?
-        resp = @connection.get('/release_session')
-        if resp.status == 200
+        resp = @connection.delete('/session')
+        if resp.status.between?(200, 299)
           @connection.headers.delete('X-Auth')
         else
-          @error = CitySDK::parseJson(resp.body)[:message]
+          @error = CitySDK::parseJson(resp.body)[:error]
           raise HostException.new(@error)
         end
       end
-      return [@updated, @created]
+      return {created: @created}
     end
   
     def delete(path)
       if authorized? 
-        resp = @connection.delete(path)
-        if resp.status == 200
-          return CitySDK::parseJson(resp.body) 
+        resp = @connection.delete(addFormat(path))
+        if resp.status.between?(200, 299)
+          @last_result = { status: resp.status, headers: resp.headers }
+          return (resp.body and resp.body !~ /\s*/) ? CitySDK::parseJson(resp.body) : ''
         end
-        @error = CitySDK::parseJson(resp.body)[:message]
+        @error = CitySDK::parseJson(resp.body)[:error]
         raise HostException.new(@error)
       end
-      raise CitySDK::Exception.new("DEL needs authorization.")
+      raise CitySDK::Exception.new("DELETE needs authorization.")
     end
   
     def post(path,data)
       if authorized? 
-        resp = @connection.post(path,data.to_json)
-        return CitySDK::parseJson(resp.body) if resp.status == 200
-        @error = CitySDK::parseJson(resp.body)[:message]
+        resp = @connection.post(addFormat(path),data.to_json)
+        @last_result = { status: resp.status, headers: resp.headers }
+        return CitySDK::parseJson(resp.body) if resp.status.between?(200, 299)
+        @error = resp.body # CitySDK::parseJson(resp.body)[:error]
+
+        File.open(File.expand_path("~/post_error_data.json"),"w") do |fd|
+          fd.write(JSON.pretty_generate({error: @error, data: data}))
+        end
+
         raise HostException.new(@error)
       end
       raise CitySDK::Exception.new("POST needs authorization.")
     end
 
+    def patch(path,data)
+      if authorized? 
+        resp = @connection.patch(addFormat(path),data.to_json)
+        @last_result = { status: resp.status, headers: resp.headers }
+        return CitySDK::parseJson(resp.body) if resp.status.between?(200, 299)
+        @error = CitySDK::parseJson(resp.body)[:error]
+        raise HostException.new(@error)
+      end
+      raise CitySDK::Exception.new("PATCH needs authorization.")
+    end
+
     def put(path,data)
       if authorized? 
-        resp = @connection.put(path,data.to_json)
-        return CitySDK::parseJson(resp.body) if resp.status == 200
-        @error = CitySDK::parseJson(resp.body)[:message]
+        resp = @connection.put(addFormat(path),data.to_json)
+        @last_result = { status: resp.status, headers: resp.headers }
+        return CitySDK::parseJson(resp.body) if resp.status.between?(200, 299)
+        @error = CitySDK::parseJson(resp.body)[:error] || {status: resp.status}
         raise HostException.new(@error)
       end
       raise CitySDK::Exception.new("PUT needs authorization.")
     end
 
     def get(path)
-      resp = @connection.get(path)
-      return CitySDK::parseJson(resp.body) if resp.status == 200
-      @error = CitySDK::parseJson(resp.body)[:message]
+      resp = @connection.get(addFormat(path))
+      @next = (resp.headers['Link'] =~ /^<(.+)>;\s*rel="next"/) ? $1 : nil
+      @last_result = { status: resp.status, headers: resp.headers }
+      return CitySDK::parseJson(resp.body) if resp.status.between?(200, 299)
+      @error = CitySDK::parseJson(resp.body)[:error]
       raise HostException.new(@error)
     end
-
-    def match_create_flush
-      
-      if @match[:nodes].length > 0
-        resp = post('util/match',@match)
-        if resp[:nodes].length > 0 
-          @create[:nodes] = resp[:nodes]
-          res = put("/nodes/#{@layer}",@create)
-          tally(res)
-          @create[:nodes] = []
-        end
-        @match[:nodes] = []
-        res
-      end
-      nil
-    end
-
-    def match_flush
-      if @match[:nodes].length > 0
-        resp = post('util/match',@match)
-        @match[:nodes] = []
-        return resp
-      end
-    end
-  
-  
+    
     def create_flush
-      if @create[:nodes].length > 0
-        tally put("/nodes/#{@layer}",@create)
-        @create[:nodes] = []
+      if @create[:features].length > 0
+        tally post("/layers/#{@layer}/objects",@create)
+        @create[:features] = []
       end
     end
 
     def tally(res)
-      if res[:status] == "success"
-        # TODO: also tally debug data!
-        @updated += res[:create][:results][:totals][:updated]
-        @created += res[:create][:results][:totals][:created]
-      end
+      @created += res.length
     end
     
   end