fulcrum 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbf32689caffd5cd03c88cd47bbec2151f2f1df9
-  data.tar.gz: da2b6713ecb79809c430ca0b146e88e11210c5f4
+  metadata.gz: 6e9e353e52485fa1f980302440b23986368b8b88
+  data.tar.gz: c0f212bc29ecb2ca29cc603a21c96ddfb09574be
 SHA512:
-  metadata.gz: 4eeff4ba0354af7d4ca5a257fc88c13cbdcc7f0b1414583b2830cc6f39dea1671c2bebda5302f63f4cc2c377cf9c82d2bba2e689582ddae59da6ee3452898b26
-  data.tar.gz: c17d79eea8e7e1ba27e7c7a1731ca8e5132598776dbfdc8ee39a15222e56b85fcaeeddbd5228e426227a5f232cefe4530f795a3640d2126e426bcc1ba654a2e3
+  metadata.gz: b1ebf6988865e7947127983f4c856c900c983962f9015a93036d4b97bc7286f80eb5c65e2b7ef2739b253c63896ca35e93c977e947297e7ffe0fc00f029a70da
+  data.tar.gz: 4c36ddb729622e26344547219173b298d5997f44fd479c5825a1de0423598b66f7280f7f8168c9be21db09945099469096e6601188105838e836416c0965c9c6

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## vTBD
+* Add roles support (#20)
+* Add audit logs support (#13)
+* Add ability to create, update, and delete projects (#16)
+* Add record history support (#15)
+* Add Query API support (#21)
+* Add authorizations support (#18)
+* Add users support (#17)
+
 ## v0.6.0
 * Add format option for fetching media tracks (default: json) (#10)
 * Lower ActiveSupport dependency to 4.1.x (#12)

data/README.md

@@ -28,12 +28,22 @@ Or install it yourself as:
 
 ## Client
 
-All interaction with the API is done through a client object. Below is a simple example of how to instantiate a client object.
+Most interaction with the API is done through a client object. Below is a simple example of how to instantiate a client object.
 
 ```ruby
 client = Fulcrum::Client.new(your_api_key)
 ```
 
+A client object assumes you have an API key. To get an API key use the `get_user` and `create_authorization` class methods.
+
+```ruby
+Fulcrum::Client.get_user(email, password)
+# returns a user's name, email, avatar url, and a list of organizations with ids for creating authorizations
+
+Fulcrum::Client.create_authorization(email, password, org_id, note, timeout = nil, user_id = nil)
+# creates an authorization for yourself or another user in the provided organization id
+```
+
 
 ## Basics
 
@@ -83,6 +93,10 @@ Update an existing record by its `id` using a `Hash` of attributes. The format o
 
 Delete a record by its `id`. This method optionally accepts a `changeset_id` to group deletes into a Changeset for compatibility with the activity feed.
 
+### client.records.find(id)
+
+Find a record's history by its `id`.
+
 
 
 ## Forms
@@ -305,6 +319,44 @@ Format can be 'json', 'geojson', 'gpx', or 'kml'.
 
 
 
+## Roles
+
+### client.roles.all(params = {})
+
+
+
+## Audit Logs
+
+### client.audit_logs.all(params = {})
+
+### client.audit_logs.find(id)
+
+
+
+## Authorizations
+
+### client.authorizations.all(params = {})
+
+### client.authorizations.find(id)
+
+### client.authorizations.update(id, authorization)
+
+### client.authorizations.delete(id)
+
+### client.authorizations.regenerate(id)
+
+
+
+## Query
+
+### client.query(sql, format = 'json')
+
+Fetches a Query API response for various formats for a provided SQL string.
+
+Format can be 'json', 'csv', or 'geojson'.
+
+
+
 ## Extra Reading
 
 * [Fulcrum API documentation](http://fulcrumapp.com/developers/api/)

data/lib/fulcrum.rb

@@ -23,5 +23,8 @@ require 'fulcrum/record'
 require 'fulcrum/layer'
 require 'fulcrum/changeset'
 require 'fulcrum/webhook'
+require 'fulcrum/role'
+require 'fulcrum/audit_log'
+require 'fulcrum/authorization'
 require 'fulcrum/client'
 

data/lib/fulcrum/audit_log.rb

@@ -0,0 +1,6 @@
+module Fulcrum
+  class AuditLog < Resource
+    include Actions::List
+    include Actions::Find
+  end
+end

data/lib/fulcrum/authorization.rb

@@ -0,0 +1,12 @@
+module Fulcrum
+  class Authorization < Resource
+    include Actions::List
+    include Actions::Find
+    include Actions::Update
+    include Actions::Delete
+
+    def regenerate(id)
+      call(:post, member_action(id, 'regenerate'))[resource_name]
+    end
+  end
+end

data/lib/fulcrum/client.rb

@@ -52,11 +52,34 @@ module Fulcrum
 
       resp.body['user']['contexts'].map do |context|
         { id: context['id'],
-          name: context['name'],
-          token: context['api_token'] }
+          name: context['name'] }
       end
     end
 
+    def self.get_user(username, password, url=DEFAULT_URL)
+      connection = create_connection(url)
+
+      connection.basic_auth(username, password)
+
+      resp = connection.get('users.json')
+      user = resp.body['user']
+      user['contexts'] = user['contexts'].map{|c| c.except!('api_token')}
+
+      user
+    end
+
+    def self.create_authorization(username, password, organization_id, note, timeout = nil, user_id = nil, url=DEFAULT_URL)
+      connection = create_connection(url)
+
+      connection.basic_auth(username, password)
+
+      body = { authorization: { organization_id: organization_id,
+                                note: note, timeout: timeout, user_id: user_id } }
+      resp = connection.post('authorizations.json', body)
+
+      resp.body['authorization']
+    end
+
     def self.create_connection(url, key = nil)
       Faraday.new(url) do |connection|
         connection.request  :multipart
@@ -124,5 +147,23 @@ module Fulcrum
     def webhooks
       @webhooks ||= Fulcrum::Webhook.new(self)
     end
+
+    def roles
+      @roles ||= Fulcrum::Role.new(self)
+    end
+
+    def audit_logs
+      @audit_logs ||= Fulcrum::AuditLog.new(self)
+    end
+
+    def authorizations
+      @authorizations ||= Fulcrum::Authorization.new(self)
+    end
+
+    def query(sql, format = 'json')
+      body = { q: sql,
+               format: format }
+      call(:post, 'query', body)
+    end
   end
 end

data/lib/fulcrum/project.rb

@@ -2,6 +2,9 @@ module Fulcrum
   class Project < Resource
     include Actions::List
     include Actions::Find
+    include Actions::Create
+    include Actions::Update
+    include Actions::Delete
   end
 end
 

data/lib/fulcrum/record.rb

@@ -11,5 +11,11 @@ module Fulcrum
 
       call(:delete, member(id), attributes_for_object(record_attributes))
     end
+
+    def history(id)
+      result = call(:get, member_action(id, 'history'))
+
+      Page.new(result, resources_name)
+    end
   end
 end

data/lib/fulcrum/role.rb

@@ -0,0 +1,5 @@
+module Fulcrum
+  class Role < Resource
+    include Actions::List
+  end
+end

data/lib/fulcrum/version.rb

@@ -1,3 +1,3 @@
 module Fulcrum
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/spec/lib/audit_log_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::AuditLog do
+  include_context 'with client'
+  include_context 'with resource'
+
+  let(:resource) { client.audit_logs }
+
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+end

data/spec/lib/authorization_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::Authorization do
+  include_context 'with client'
+  include_context 'with resource'
+
+  let(:resource) { client.authorizations }
+
+  include_examples 'lists resource'
+  include_examples 'finds resource'
+  include_examples 'updates resource'
+  include_examples 'deletes resource'
+end

data/spec/lib/client_spec.rb

@@ -6,4 +6,50 @@ describe Fulcrum::Client do
   it 'has a default url' do
     expect(client.url).to eq(Fulcrum::Client::DEFAULT_URL)
   end
+
+  it 'can query' do
+    url = "#{client.url}/query"
+    response = 'audio,system,,,,,'
+
+    stub_request(:post, url)
+      .with(body: '{"q":"select name from tables limit 1;","format":"csv"}')
+      .to_return(status: 200, body: response,
+                 headers: {"Content-Type" => "text/plain"})
+
+    sql = 'select name from tables limit 1;'
+    csv = client.query(sql, 'csv')
+
+    expect(csv).to eq(response)
+  end
+
+  it 'can get_user' do
+    url = 'https://fred%40flinstones.com:secret@api.fulcrumapp.com/api/v2/users.json'
+    response = '{"user":{"first_name":"Jason","last_name":"Sanford","email":"jason@fulcrumapp.com","image_small":"https://fulcrumapp-dev.s3.amazonaws.com/user-images/small_abc.jpg","image_large":"https://fulcrumapp-dev.s3.amazonaws.com/user-images/large_abc.jpg","id":"49d06ce5-1457-476c-9cb4-fd9d41ea43ef","contexts":[{"name":"Team Jason","id":"e09c1a03-819d-47d6-aebc-f8712d292b57","api_token":"abc123","image_small":"https://fulcrumapp-dev.s3.amazonaws.com/organization-images/small_abc.jpg","image_large":"https://fulcrumapp-dev.s3.amazonaws.com/organization-images/large_abc.jpg","type":"organization","role":{},"domain":null,"plan":{}}],"access":{"allowed":true}}}'
+
+    stub_request(:get, url)
+      .to_return(status: 200, body: response,
+                 headers: {"Content-Type" => "application/json"})
+
+    sql = 'select name from tables limit 1;'
+    user = Fulcrum::Client.get_user('fred@flinstones.com', 'secret')
+
+    expect(user['contexts'].length).to eq(1)
+    expect(user['contexts'][0]['id']).to eq('e09c1a03-819d-47d6-aebc-f8712d292b57')
+  end
+
+  it 'can create_authorization' do
+    url = 'https://fred%40flinstones.com:secret@api.fulcrumapp.com/api/v2/authorizations.json'
+    body = '{"authorization":{"organization_id":"abc-123","note":"Tess Ting","timeout":null,"user_id":null}}'
+    response = '{"authorization":{"note":"Tess Ting","expires_at":null,"timeout":null,"token_last_8":"46c5cb33","last_ip_address":null,"last_user_agent":null,"token":"ac493349cd4de0c376185c1d347d24ce5a3867bd3e04397bb875ed6b9b0546b768caa3bf46c5cb33","created_at":"2019-04-12T13:25:28Z","updated_at":"2019-04-12T13:25:28Z","id":"f1d84caa-da28-4fc5-a341-44bb9efa6266","last_used_at":null,"user_id":"4f1cfa091441405373000443"}}'
+
+    stub_request(:post, url)
+      .with(body: body)
+      .to_return(status: 200, body: response,
+                 headers: {"Content-Type" => "application/json"})
+
+    authorization = Fulcrum::Client.create_authorization('fred@flinstones.com', 'secret', 'abc-123', 'Tess Ting')
+
+    expect(authorization['note']).to eq('Tess Ting')
+    expect(authorization['token_last_8']).to eq('46c5cb33')
+  end
 end

data/spec/lib/project_spec.rb

@@ -10,4 +10,7 @@ describe Fulcrum::Project do
 
   include_examples 'lists resource'
   include_examples 'finds resource'
+  include_examples 'creates resource'
+  include_examples 'updates resource'
+  include_examples 'deletes resource'
 end

data/spec/lib/record_spec.rb

@@ -13,4 +13,23 @@ describe Fulcrum::Record do
   include_examples 'creates resource'
   include_examples 'updates resource'
   include_examples 'deletes resource'
+
+  it 'lists all resources' do
+    url = "#{client.url}/records/abc-123/history.json"
+
+    stub_request(:get, url)
+      .to_return(status: 200, body: list_response,
+                 headers: {"Content-Type" => "application/json"})
+
+    page = resource.history('abc-123')
+
+    expect(client.response.status).to eq(200)
+
+    expect(page).to respond_to(:current_page)
+    expect(page).to respond_to(:total_pages)
+    expect(page).to respond_to(:total_count)
+    expect(page).to respond_to(:per_page)
+
+    expect(page.objects).to be_a(Array)
+  end
 end

data/spec/lib/role_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+include Support::ResourceExamples
+
+describe Fulcrum::Role do
+  include_context 'with client'
+  include_context 'with resource'
+
+  let(:resource) { client.roles }
+
+  include_examples 'lists resource'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fulcrum
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Fulcrum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2019-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -148,6 +148,8 @@ files:
 - lib/fulcrum/actions/media_versions.rb
 - lib/fulcrum/actions/update.rb
 - lib/fulcrum/audio.rb
+- lib/fulcrum/audit_log.rb
+- lib/fulcrum/authorization.rb
 - lib/fulcrum/changeset.rb
 - lib/fulcrum/choice_list.rb
 - lib/fulcrum/classification_set.rb
@@ -161,6 +163,7 @@ files:
 - lib/fulcrum/project.rb
 - lib/fulcrum/record.rb
 - lib/fulcrum/resource.rb
+- lib/fulcrum/role.rb
 - lib/fulcrum/signature.rb
 - lib/fulcrum/version.rb
 - lib/fulcrum/video.rb
@@ -171,6 +174,8 @@ files:
 - spec/data/test.mp4
 - spec/data/test.png
 - spec/lib/audio_spec.rb
+- spec/lib/audit_log_spec.rb
+- spec/lib/authorization_spec.rb
 - spec/lib/choice_list_spec.rb
 - spec/lib/classification_set_spec.rb
 - spec/lib/client_spec.rb
@@ -180,6 +185,7 @@ files:
 - spec/lib/photo_spec.rb
 - spec/lib/project_spec.rb
 - spec/lib/record_spec.rb
+- spec/lib/role_spec.rb
 - spec/lib/signature_spec.rb
 - spec/lib/video_spec.rb
 - spec/lib/webhook_spec.rb
@@ -205,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Fulcrum API client for ruby
@@ -216,6 +222,8 @@ test_files:
 - spec/data/test.mp4
 - spec/data/test.png
 - spec/lib/audio_spec.rb
+- spec/lib/audit_log_spec.rb
+- spec/lib/authorization_spec.rb
 - spec/lib/choice_list_spec.rb
 - spec/lib/classification_set_spec.rb
 - spec/lib/client_spec.rb
@@ -225,6 +233,7 @@ test_files:
 - spec/lib/photo_spec.rb
 - spec/lib/project_spec.rb
 - spec/lib/record_spec.rb
+- spec/lib/role_spec.rb
 - spec/lib/signature_spec.rb
 - spec/lib/video_spec.rb
 - spec/lib/webhook_spec.rb