fortytwo 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6952833d0651aa41b4fec55e1e642e2b0c1f69c6
-  data.tar.gz: b7043903d72e39385f6e48cf6b127f63987c17cd
+  metadata.gz: f6abbbceb4da8a60b40ba1d75fd220034b273261
+  data.tar.gz: ba51dce948dd36f78025847037a026c562ab3f35
 SHA512:
-  metadata.gz: cf7bdef762b93f1ec6359d90426f64e585ec2116df4de82823511c71aed2cc6d33c17dc36d51ccaca090b715a3182d5526174d82e3538fd3a87a3b94aa944c88
-  data.tar.gz: 033e1f170801bfbb8806b7ad9ac607ff891eb68fb9fd12901ce057747a03be9c1e7ecccb7b065653b6af0a566268f78b59189d9aa478a2ebdff5fa0ed15e6cfa
+  metadata.gz: a762879b2330d8383afa7645d7538130a29bf6ffbd586db494b159e75e21d0fc7d169d018c05fa6e46a7698f918864e82a467ca5cc39d1f8ef5275d6a9dc9284
+  data.tar.gz: 1eaaa12909726e39e30a02b1e760c57c38411ca525b7e1b5c76624884cba6a8e37af07e13d25f599f12bbf728bbddcf4418471e8c713fbc5418dd86723dbe901

data/README.md

@@ -0,0 +1,79 @@
+# fortytwo
+
+This ruby gem provides a simple interface to the 42 API. Consuming data from the API is now easier and more readable.
+
+
+## Install
+
+Add this to your application's Gemifle:
+
+```ruby
+gem 'fortytwo'
+```
+
+And then execute:
+
+```ruby
+bundle install
+```
+
+Or install it yourself as:
+```ruby
+gem install fortytwo
+```
+NOTE: IF YOU'RE INSTALLING IN THE CLUSTER'S MACS, SETUP LOCALLY LIKE THIS:
+```ruby
+gem install --user-install fortytwo
+```
+
+### Get your API key and secret
+
+This gem uses a client model to query against the API. You need to create and configure a 42 App containing your API key and API secret and make requests through that. Go here (https://profile.intra.42.fr/oauth/applications/new) to create the app and get the keys. You can name it whatever you want and redirect it wherever you want. 
+
+## Usage
+
+### Initialize
+
+Once you have you're key's you can initialize it like this:
+
+```ruby 
+require 'fortytwo'
+
+client = FortyTwo::Client.new({ api_key: YOUR_API_KEY, api_secret: YOUR_API_SECRET })
+```
+
+### Responses
+
+Responses from the API are all parsed and converted into Ruby objects. This way, you're able to access information using dot notation.
+
+```ruby
+response = client.user("bsaget")
+user     = response.user
+
+user.id							#=> 
+user.first_name             	#=> Bob
+user.last_name                	#=> Saget
+user.cursus_users.first.level  	#=> 12.3
+
+user.instance_variables
+# [:@id, :@email, :@login, :@first_name, :@last_name, :@url, :@phone, :@displayname, :@image_url,
+#  :@staff, :@correction_point, :@pool_month, :@pool_year, :@location, :@wallet, :@groups,
+#  :@cursus_users, :@projects_users, :@achievements, :@titles, :@partnerships, :@patroned,
+#  :@patroning, :@expertises_users, :@campus]
+
+user.cursus_users.first.instance_variables
+# [:@id, :@begin_at, :@end_at, :@grade, :@level, :@skills, :@cursus_id, :@user, :@cursus]
+
+user.projects_users.first.instance_variables
+# [:@id, :@occurrence, :@final_mark, :@status, :@validated, :@current_team_id, :@project, :@cursus_ids]
+
+user.expertises_users.first.instance_variables
+# [:@id, :@expertise_id, :@interested, :@value, :@contact_me, :@created_at, :@user_id]
+
+user.campus.first.instance_variables
+# [:@id, :@name, :@time_zone, :@language, :@users_count, :@vogsphere_id]
+
+
+```
+
+That's it! You have access to all the info obtained from a User request to the 42 API.

data/lib/fortytwo/responses/models/project_user.rb

@@ -5,7 +5,7 @@ module FortyTwo
   module Response
     module Model
       class ProjectUser < Response::Base
-        attr_reader :id, :occurence, :final_mark, :status,
+        attr_reader :id, :occurence, :final_mark, :status, :validated,
                     :current_team_id, :project, :cursus_ids
 
         def initialize(json)

data/lib/fortytwo/responses/models/user.rb

@@ -11,7 +11,9 @@ module FortyTwo
         attr_reader :id, :email, :login, :first_name, :last_name, :url, :phone,
                     :displayname, :image_url, :correction_point, :staff,
                     :pool_month, :pool_year, :location, :wallet, :cursus_users,
-                    :projects_users, :expertises_users, :campus
+                    :projects_users, :expertises_users, :campus, :groups,
+                    :achievements, :titles, :partnerships, :patroned,
+                    :patroning, :expertises_users
 
         def initialize(json)
           super(json)

data/lib/fortytwo/version.rb

@@ -1,3 +1,3 @@
 module FortyTwo
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fortytwo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Matias Fernandez