data_guru 0.4.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 596c654f0a314f25642dcec4f6215855fb162f2e
-  data.tar.gz: 9e7b366fcb502b7d1d52ca89dcc63695e9af047b
+  metadata.gz: 3385e9759c76cf598810c880efcb0011dc62331e
+  data.tar.gz: 86cc6fe4ee3c388e111156b00e5d54f8e1674603
 SHA512:
-  metadata.gz: 1bb1d3def03cf3d6e0815e010b54616a414221f07a170a81f12c22478ca7534edef2923cd63f405d7c3a681598beeb858b47cba1b837ca9fee794eb4f302b5ad
-  data.tar.gz: b50f495835e174e425b8e4c6ec50f6e92ac83f9edc13276467b8d7dca686cae0bc4e8aa7c4eeb8a65df47c76aeecc0221fd8ca657b4a361927f2f774f144a568
+  metadata.gz: 1320b19b6d3f119730dcd173b31660754da2585490b758c7b9269c76a1c8d70300283f280b7e5b476188a361cc48efcf0d2331175467d745074fab99ac1cc363
+  data.tar.gz: 1d7a38793ecbe88a33eba71d70d954b7fed3b90bfe3d72ac5d9be0f51b796a26f1e83bfc3b57efe5f64a0abc43c41003dfa9530efbe13115210eed068f4cc134

data/README.md

@@ -35,21 +35,21 @@ DataGuru.configure do |config|
 end
 ```
 
-Possible configuration values:
+**Required** configuration values:
 
-`api_url` - *[mandatory]* api server where data from Permissions is stored
+`api_url` - url of server managing the Permissions repo
 
-`access_token` - *[mandatory]* token needed for verifying access to api server
+`access_token` - token for authorizing access to the server
 
-## Usage
+## Use
 
 If you use default config files (see Permissions section below) you can simply do:
 
 ```ruby
-data = DataGuru::Client.new
+data = DataGuru::Client.new(api_url: <URL>, access_token: <TOKEN>)
 
 # get collections
-data.users.all
+data.members.all
 data.projects.all
 data.github_teams.all
 data.google_groups.all
@@ -58,20 +58,20 @@ data.toggl_teams.all
 
 # find in collections by attribute
 data.projects.find{ |project| project.display_name == 'Some project' }
-data.users.find{ |user| user.github == 'example' }
+data.members.find{ |member| member.github == 'example' }
 
-# filter through collections by attributes
-data.users.select{ |user| user.external }
-data.users.select{ |user| user.public_key.nil? }.count
+# filter collections by attributes
+data.members.select{ |member| member.external }
+data.members.select{ |member| member.public_key.nil? }.count
 
-# select key names of all github teams user belongs to
-user = data.users.first
-data.github_teams.select{ |team| team.members.include?(user.id) }.map(&:id)
+# select key names of all github teams a member belongs to
+member = data.members.first
+data.github_teams.select{ |team| team.members.include?(member.id) }.map(&:id)
 ```
 
-The collections have `Enumerable` module included so you can filter models by attributes easily (`data.users.select{ |user| user.some_method }`)
+The collections `include Enumerable` module so that you can filter models by attributes easily (`data.members.select{ |member| member.some_method }`).
 
-You can refresh repo and storage at any time, just do:
+You can refresh repo and storage at any time:
 
 ```ruby
 data = DataGuru::Client.new
@@ -82,54 +82,62 @@ On a single model you can do:
 
 ```ruby
 data = DataGuru::Client.new
-user = data.users.all.first
+member = data.members.all.first
 
-# to get list of user attributes
-user.attributes
+# to get list of member attributes
+member.attributes
 
 # to get list of permitted and required attributes (see Permisions section below)
-user.permitted_attributes
-user.required_attributes
+member.permitted_attributes
+member.required_attributes
 
-# check if user has all required attributes set
-user.valid?
-user.missing_attributes
+# check if member has all required attributes set
+member.valid?
+member.missing_attributes
 ```
 
-Each model has a set of getter methods (permitted_attributes) so you can for example do `user.github` to get just the github username of the user.
-Each model also has `id` method which returns the name of the file, for example for the user in a file `john.doe.yml` will return `john.doe`.
+Each model has a set of getter methods (`permitted_attributes`), so for example you can do `member.github` to get just the github membername.
+Each model also has `id` method which returns the name of the file the member is stored in, for example it will return `john.doe` for the member in the file `john.doe.yml`.
 
 You can check whether configuration (in your rails app) and model configuration (in your permissions repo) is valid by running `DataGuru::Client.new.errors`.
 
 ### Permissions
 
-A sample permissions repo contains a `config` directory with files like `user.yml`, `project.yml`, `github_team.yml`. In these files you specify attributes for each model with information about whether they are required, what is the default value and what type of value it is.
+A sample permissions repo contains a `config/` directory with files like `member.yml`, `project.yml`, `github_team.yml`. In these files you specify attributes of each model with information about whether they are required, what is the default value, and what is the datatype.
 
-```
+```yaml
 ---
-name:
-  required: true
-  default_value:
-  value_type: string
 emails:
+  default_value: []
   required: true
-  default_value:
   value_type: array
 external:
-  required: false
   default_value: false
+  required: true
   value_type: boolean
+github:
+  default_value:
+  required: true
+  value_type: string
+name:
+  default_value:
+  required: true
+  value_type: string
+public_key:
+  default_value:
+  required: true
+  value_type: string
 ```
 
-The methods `permitted_attributes` and `required_attributes` returns the array of specified attributes.
+The methods `permitted_attributes` and `required_attributes` return array of specified attributes.
 
-All the files should be under the appropriate directory, for example all users under `users` directory, they can be nested if you want.
+All files should stay in appropriate directories, e.g. store members in `members/` directory.
 
-For more information see the [permissions template repo](https://github.com/ardhena/permissions-template).
+For more details see the [sample permissions repo](https://github.com/netguru/access-permissions-sample).
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run 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).
 

data/lib/data_guru/collection.rb

@@ -32,11 +32,12 @@ module DataGuru
     end
 
     def collection_resource_url(collection_type)
-      "#{DataGuru.config.api_url}/#{collection_type}?token=#{DataGuru.config.access_token}"
+      "#{DataGuru.config.api_url}/collections/#{collection_type}" \
+        "?token=#{DataGuru.config.access_token}"
     end
 
     def config_resource_url
-      "#{DataGuru.config.api_url}/config?token=#{DataGuru.config.access_token}"
+      "#{DataGuru.config.api_url}/collections/config?token=#{DataGuru.config.access_token}"
     end
 
     def config_data

data/lib/data_guru/validation.rb

@@ -21,7 +21,8 @@ module DataGuru
     end
 
     def config_resource_url
-      "#{DataGuru.config.api_url}/config?token=#{DataGuru.config.access_token}"
+      "#{DataGuru.config.api_url}/collections/config" \
+        "?token=#{DataGuru.config.access_token}"
     end
 
     def keys

data/lib/data_guru/version.rb

@@ -1,3 +1,3 @@
 module DataGuru
-  VERSION = "0.4.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: data_guru
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Adam Nowak
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport