grom_native 0.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Matt Rayner
+
+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/Makefile

@@ -0,0 +1,40 @@
+.PHONY: build-and-test build install install-go install-ruby test test-go test-ruby check-built proto setup
+
+build-and-test: install setup test
+
+build:
+	@echo "-- Building library"
+	go build -buildmode=c-shared -o ./ext/gromnative.so ./ext/gromnative.go
+
+install: install-go install-ruby
+
+install-go:
+	@echo "-- Installing Go Dependencies"
+	dep ensure
+
+install-ruby:
+	@echo "-- Install Ruby Dependencies"
+	bundle install
+
+test: test-go test-ruby
+
+test-go:
+	@echo "-- Testing library"
+	ginkgo ./ext/...
+
+test-ruby: check-built
+	@echo "-- Testing gem"
+	bundle exec rake
+
+check-built:
+	@echo "-- Checking for built library"
+	@[ -f ./ext/gromnative.so ] && echo "Lib found, not building" || make build
+
+proto:
+	@echo "-- Building Protobuf files"
+	protowrap -I. --go_out `go env GOPATH`/src ./**/**/*.proto
+
+setup:
+	@echo "-- Installing testing framework"
+	go get -u github.com/onsi/ginkgo/ginkgo
+	go get -u github.com/onsi/gomega/...

data/README.md

@@ -0,0 +1,71 @@
+# GromNative
+
+## Quick Start
+```bash
+brew install protobuf ginkgo
+make install
+make test
+```
+
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+[![Go Report Card](https://goreportcard.com/badge/github.com/ukparliament/gromnative)](https://goreportcard.com/report/github.com/ukparliament/gromnative)
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grom_native'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install GromNative
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/GromNative. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GromNative project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/GromNative/blob/master/CODE_OF_CONDUCT.md).
+
+```bash
+./bin/console
+require 'parliament/grom/decorator'; n = GromNative.fetch(uri: 'http://api.parliament.uk/query/person_by_id.nt?person_id=43RHonMf', filter: ['https://id.parliament.uk/schema/Person'], decorators: Parliament::Grom::Decorator).first
+```
+
+```bash
+require 'parliament/grom/decorator'
+require 'benchmark'
+
+puts Benchmark.measure {
+    10.times do
+        GromNative.fetch(uri: 'http://api.parliament.uk/query/person_by_id.nt?person_id=43RHonMf', filter: ['https://id.parliament.uk/schema/Person'], decorators: Parliament::Grom::Decorator).first
+    end
+}
+
+puts Benchmark.measure {
+    GromNative.fetch(uri: 'http://api.parliament.uk/query/person_index', filter: ['https://id.parliament.uk/schema/Person'], decorators: Parliament::Grom::Decorator)
+}
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "grom_native"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/gromnative.go

@@ -0,0 +1,82 @@
+package main
+
+import (
+	"C"
+	"encoding/json"
+	"fmt"
+	"github.com/ukparliament/gromnative/ext/net"
+	"github.com/ukparliament/gromnative/ext/processor"
+	. "github.com/ukparliament/gromnative/ext/types/net"
+	"log"
+)
+
+type Response struct {
+	StatementsBySubject map[string][]processor.Triple  `json:"statementsBySubject"`
+	EdgesBySubject      map[string]map[string][]string `json:"edgesBySubject"`
+	StatusCode          int32                          `json:"statusCode"`
+	Uri                 string                         `json:"uri"`
+	Err                 string                         `json:"error"`
+}
+
+func GetandProcess(uri string) (Response, error) {
+	// Placeholder response object
+	response := Response{ Uri: uri }
+
+	log.Printf("Requesting: %v\n", uri)
+
+	requestResponse, err := net.Get(&GetInput{Uri: uri})
+	if requestResponse.StatusCode != 0 {
+		response.StatusCode = requestResponse.StatusCode
+	}
+
+	if err != nil {
+		log.Printf("Error getting: %v\n", err)
+		response.Err = requestResponse.Error
+		return response, err
+	}
+
+	processedData, err := processor.Process(&processor.ProcessorInput{Body: requestResponse.Body})
+	if err != nil {
+		log.Printf("Error processing: %v\n", err)
+		response.Err = processedData.Error
+		return response, err
+	}
+
+	response.StatementsBySubject = processedData.StatementsBySubject
+	response.EdgesBySubject = processedData.EdgesBySubject
+
+	log.Println("Done")
+
+	return response, nil
+}
+
+func cStringConversion(response *Response) *C.char {
+	json, err := json.Marshal(response)
+	if err != nil {
+		return C.CString("{\"error\": \"error creating json for ruby\"}")
+	}
+
+	return C.CString(string(json))
+}
+
+//export get
+func get(data *C.char) *C.char {
+	uri := C.GoString(data)
+	response, err := GetandProcess(uri)
+	if err != nil {
+		errorResponse := &Response{ Err: fmt.Sprintf("Error getting data: %v\n", err) }
+		log.Println(errorResponse.Err)
+		return cStringConversion(errorResponse)
+	}
+
+	responseJson, err := json.Marshal(response)
+	if err != nil {
+		errorResponse := &Response{ Err: fmt.Sprintf("Error marshalling data: %v\n", err) }
+		log.Println(errorResponse.Err)
+		return cStringConversion(errorResponse)
+	}
+
+	return C.CString(string(responseJson))
+}
+
+func main() {}

data/ext/gromnative_test.go

@@ -0,0 +1,150 @@
+package main
+
+import (
+  . "github.com/onsi/ginkgo"
+  . "github.com/onsi/gomega"
+  "github.com/ukparliament/gromnative/ext/processor"
+  "gopkg.in/jarcoal/httpmock.v1"
+  "io/ioutil"
+  "log"
+  "testing"
+)
+
+func TestProcessor(t *testing.T) {
+  log.SetOutput(ioutil.Discard)
+  RegisterFailHandler(Fail)
+  RunSpecs(t, "gromnative Suite")
+}
+
+var _ = BeforeSuite(func() {
+  // block all HTTP requests
+  httpmock.Activate()
+})
+
+var _ = BeforeEach(func() {
+  // remove any mocks
+  httpmock.Reset()
+})
+
+var _ = AfterSuite(func() {
+  httpmock.DeactivateAndReset()
+})
+
+var _ = Describe("gromnative", func() {
+  Describe("GetandProcess", func() {
+    Context("with expected data", func() {
+      BeforeEach(func() {
+        fixture, _ := ioutil.ReadFile("../spec/fixtures/one_edge.nt")
+
+        httpmock.RegisterResponder("GET", "https://api.parliament.uk/query/person_by_id?person_id=43RHonMf",
+          httpmock.NewStringResponder(200, string(fixture)))
+      })
+
+      It("returns the expected data", func() {
+        statementsBySubject := make(map[string][]processor.Triple)
+        statementsBySubject["https://id.parliament.uk/43RHonMf"] = append(
+          statementsBySubject["https://id.parliament.uk/43RHonMf"],
+          processor.Triple {
+            Subject: "https://id.parliament.uk/43RHonMf",
+            Predicate: "http://www.w3.org/1999/02/22-rdf-syntax-ns#type",
+            Object: "<https://id.parliament.uk/schema/Person>",
+          },
+          processor.Triple {
+            Subject: "https://id.parliament.uk/43RHonMf",
+            Predicate: "https://id.parliament.uk/schema/personGivenName",
+            Object: "\"Diane\"^^<xsd:string>",
+          },
+          processor.Triple {
+            Subject: "https://id.parliament.uk/43RHonMf",
+            Predicate: "https://id.parliament.uk/schema/personOtherNames",
+            Object: "\"Julie\"^^<xsd:string>",
+          },
+          processor.Triple {
+            Subject: "https://id.parliament.uk/43RHonMf",
+            Predicate: "https://id.parliament.uk/schema/personFamilyName",
+            Object: "\"Abbott\"^^<xsd:string>",
+          },
+          processor.Triple {
+            Subject: "https://id.parliament.uk/43RHonMf",
+            Predicate: "http://example.com/F31CBD81AD8343898B49DC65743F0BDF",
+            Object: "\"Ms Diane Abbott\"^^<xsd:string>",
+          },
+          processor.Triple {
+            Subject: "https://id.parliament.uk/43RHonMf",
+            Predicate: "http://example.com/D79B0BAC513C4A9A87C9D5AFF1FC632F",
+            Object: "\"Rt Hon Diane Abbott MP\"^^<xsd:string>",
+          },
+          processor.Triple {
+            Subject: "https://id.parliament.uk/43RHonMf",
+            Predicate: "https://id.parliament.uk/schema/Test",
+            Object: "<https://id.parliament.uk/12345678>",
+          })
+        edgesBySubject := make(map[string]map[string][]string)
+        edgesBySubject["https://id.parliament.uk/43RHonMf"] = make(map[string][]string)
+        edgesBySubject["https://id.parliament.uk/43RHonMf"]["Test"] = append(
+          edgesBySubject["https://id.parliament.uk/43RHonMf"]["Test"],
+          "https://id.parliament.uk/12345678")
+
+        expected := Response{
+          StatementsBySubject: statementsBySubject,
+          EdgesBySubject: edgesBySubject,
+          StatusCode: 200,
+          Uri: "https://api.parliament.uk/query/person_by_id?person_id=43RHonMf",
+          Err: "",
+        }
+
+        res, err := GetandProcess("https://api.parliament.uk/query/person_by_id?person_id=43RHonMf")
+
+        Expect(res).To(Equal(expected))
+        Expect(err).NotTo(HaveOccurred())
+      })
+    })
+
+    Context("with an error getting", func() {
+      BeforeEach(func() {
+        httpmock.DeactivateAndReset()
+      })
+
+      AfterEach(func() {
+        httpmock.Activate()
+      })
+
+      It("returns the expected data", func() {
+        expected := Response{
+          StatementsBySubject: nil,
+          EdgesBySubject: nil,
+          StatusCode: 0,
+          Uri: "foo://a_broken.url",
+          Err: "Get foo://a_broken.url: unsupported protocol scheme \"foo\"",
+        }
+
+        res, err := GetandProcess("foo://a_broken.url")
+
+        Expect(res).To(Equal(expected))
+        Expect(err.Error()).To(Equal("Get foo://a_broken.url: unsupported protocol scheme \"foo\""))
+      })
+    })
+
+    Context("with an error processing", func() {
+      BeforeEach(func() {
+        httpmock.RegisterResponder("GET", "https://api.parliament.uk/query/person_by_id?person_id=43RHonMf",
+          httpmock.NewStringResponder(200, "{\"error\":\"Definitely not Triples\"}"))
+      })
+
+      It("returns the expected data", func() {
+        expected := Response{
+          StatementsBySubject: nil,
+          EdgesBySubject: nil,
+          StatusCode: 200,
+          Uri: "https://api.parliament.uk/query/person_by_id?person_id=43RHonMf",
+          Err: "lenient parsing: line 1: invalid subject in {\"error\":\"Definitely not Triples\"}",
+        }
+
+        res, err := GetandProcess("https://api.parliament.uk/query/person_by_id?person_id=43RHonMf")
+
+        Expect(res).To(Equal(expected))
+        Expect(err.Error()).To(Equal("lenient parsing: line 1: invalid subject in {\"error\":\"Definitely not Triples\"}"))
+      })
+    })
+  })
+})

data/ext/net/net.go

@@ -0,0 +1,63 @@
+package net
+
+import (
+	"errors"
+	"fmt"
+	netType "github.com/ukparliament/gromnative/ext/types/net"
+	"io/ioutil"
+	"net/http"
+)
+
+func Get(input *netType.GetInput) (*netType.GetOutput, error) {
+	output := &netType.GetOutput{Uri: input.Uri}
+
+	// Build a new get request object
+	request, err := http.NewRequest("GET", input.Uri, nil)
+	if err != nil {
+		output.Error = err.Error()
+		return output, err
+	}
+
+	// Add any header objects to our request
+	for i := 0; i < len(input.Headers); i++ {
+		request.Header.Add(input.Headers[i].Key, input.Headers[i].Value)
+	}
+
+	// Perform our request
+	client := http.Client{}
+	resp, err := client.Do(request)
+	if resp != nil {
+		defer resp.Body.Close()
+	}
+
+	if err != nil {
+		output.Error = err.Error()
+		return output, err
+	}
+
+	// Store the response code
+	if resp.StatusCode != 0 {
+		output.StatusCode = int32(resp.StatusCode)
+	}
+
+	// Read the body into a []byte
+	body, err := ioutil.ReadAll(resp.Body)
+
+	if err != nil {
+		errorMessage := fmt.Sprintf("Error reading body from %v: %v", input.Uri, err)
+		output.Error = errorMessage
+		return output, err
+	}
+
+	output.Body = body
+
+	// Handle non-200 responses
+	if resp.StatusCode != 200 {
+		errorMessage := fmt.Sprintf("Received %v status code from %v: %s", resp.StatusCode, input.Uri, body)
+
+		output.Error = errorMessage
+		return output, errors.New(errorMessage)
+	}
+
+	return output, err
+}