plate_api 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d6286414ebf7faeb04ee3886b71b11b367cbb1d39138e06a96960bd73aa9012
-  data.tar.gz: c7cf1783b9491e1dfc41399c1b93133997573723aaee8c5df04e96298a7998b1
+  metadata.gz: b0c558f4ea358b0ddbca4fe9b389e67c1b981b2efaf2fa209e051d56200becb4
+  data.tar.gz: 9608c63f10f9e5d8d62b8a24d83665c4d80f6b40a97eb9aba466d11c80986505
 SHA512:
-  metadata.gz: 7dea1b06ec0c8ae3bbfb718f87e4bcb13bd9e2fd822d78ca51ebbf91a8fa3eceafc247174a72d9368b41b78b6f935a60363f1a67823186afe0167776077ad2ff
-  data.tar.gz: af44af8cf34d342fe1650c137d754d57ad1323ee5f6fbc4b542706eb4b867545aba385b245e50369701cbdd5d3246458c5fca30dd604233c6a1c587ea0596dcc
+  metadata.gz: a2f9481b9da9bc6f958761fdf81158e4ef4d19f89240a499bc754ebd7756e34707c6c8bea059a6c636e9ccb7d554b8eb15e14725bb95870b4bd8b2d1fb5a041b
+  data.tar.gz: af2b1fd5d3c4fd19fbdfee8574a41a86eb15ba97347c46f230135c5f82bb6edd1f4fa1dbf8d68671f85af46370091feffa5bf7e492882a3ae7c746d4faf43683

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plate_api (1.1.0)
+    plate_api (1.1.1)
       faraday (~> 0.15.4)
       faraday_middleware (~> 0.13.1)
       mimemagic (~> 0.3.3)

data/README.md

@@ -5,7 +5,7 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/1e1dafadc880983ce63a/test_coverage)](https://codeclimate.com/github/platehub/plate_api/test_coverage)
 # PlateApi
 
-Welcome to the PlateApi gem. This gem provides a wrapper to communicate with the Plate API, taking care of
+Welcome to the PlateApi gem. This gem provides a wrapper to communicate with the [Plate API](https://api-doc.getplate.com), taking care of
 authentication.
 
 ## Installation
@@ -24,16 +24,16 @@ Or install it yourself as:
 
     $ gem install plate_api
 
-## Getting started
+## Getting started (TLDR;)
 
 To get started with a simple connector:
 
 ```
 # Initialze a connector
-con == PlateApi::Connector.new("{{public_key}}", "{{secret_key}}")
+plate_api = PlateApi.new("{{public_key}}", "{{secret_key}}")
 
 # Find information of a specific site with id == 822
-site = con.sites.find(822)
+site = plate_api.sites.find(822)
 
 # Find all posts in this site
 posts = site.posts
@@ -47,9 +47,101 @@ element = elements.first
 element.update(body: "<h2>My new text</h2>")
 ```
 
+## Establishing a connection object
+
+To create a connection object, representing a connection to the Plate API,
+you need a public and a secret key. The [Plate API docs](https://api-doc.getplate.com) explain how to get such keys.
+
+Given these two keys, a connection object can be established as follows:
+
+```
+plate_api = PlateApi.new("{{public_key}}", "{{secret_key}}")
+```
+
+The Plate API object can be used to find resources with a certain id:
+
+## Retrieve a resource by id.
+
+To retrieve a resource with a specific id, do the following: (to retrieve an element with `id=12`)
+
+```
+element = plate_api.elements.find(12)
+```
+
+## Create/Update/Delete resources given an object
+
+To create a resource, you first retrieve the parent of the resource you want to create.
+Second, you pass the create parameters in the `create_{{resource}}` method:
+
+```
+column = plate_api.columns.find(12)
+element = column.create_element(content_type_id: 71, some_content_parameter: "Avé moi")
+```
+
+To update a resource:
+
+```
+element = plate_api.element.find(36)
+element.update(some_content_parameter: "New content")
+```
+
+To delete a resource (be careful):
+
+```
+element = plate_api.element.find(223)
+element.delete
+```
+
+## Create/Update/Delete resources directly:
+
+It is also possible to use the `plate_api` instance to execute actions directly,
+without first retrieving the object itself.
+
+To create a resource:
+
+```
+column = plate_api.columns.find(12)
+plate_api.elements.create(column, content_type_id: 71, some_content_parameter: "Avé moi")
+```
+
+To update a resource :
+
+```
+plate_api.elements.update(36, some_content_parameter: "New content")
+```
+
+To delete a resource:
+
+```
+plate_api.elements.delete(223)
+```
+
+## List child resources
+
+To list all childs of a resource, for example to get all elements in a section:
+
+```
+section = plate_api.sections.find(50)
+all_elements = section.elements
+```
+
+To pass some arguments to the request (like pagination, or to filter on content_type):
+
+```
+section = plate_api.sections.find(50)
+all_elements = section.elements(content_type_id: 150, page: 12, per_page: 10)
+```
+
+To find the total amount of childs of a resource:
+
+```
+section = plate_api.sections.find(50)
+count = section.elements_total_count
+```
+
 ## 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 `rspec 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).
 

data/lib/plate_api/object_handler.rb

@@ -17,7 +17,7 @@ module PlateApi
       if result["data"]
         return new_object(result["data"])
       else
-        puts "No result: #{result}"
+        puts "PlateApi: No success: #{result}"
         return nil
       end
     end
@@ -30,7 +30,7 @@ module PlateApi
       if result["data"]
         return new_object(result["data"])
       else
-        puts "No result: #{result}"
+        puts "PlateApi: No success: #{result}"
         return nil
       end
     end
@@ -50,7 +50,7 @@ module PlateApi
       if result["data"]
         return new_object(result["data"])
       else
-        puts "No result: #{result}"
+        puts "PlateApi: No success: #{result}"
         return nil
       end
     end
@@ -61,7 +61,7 @@ module PlateApi
       if result["data"]
         return new_object(result["data"])
       else
-        puts "No result: #{result}"
+        puts "PlateApi: No success: #{result}"
         return nil
       end
     end
@@ -74,7 +74,17 @@ module PlateApi
       if result["data"]
         return result["data"].map{|x| new_object(x)}
       else
-        puts "No result: #{result}"
+        puts "PlateApi: No success: #{result}"
+        return nil
+      end
+    end
+
+    def index_total_count(parent)
+      result = @api_connector.get(collection_path(parent.class, parent.id), per_page: 1)
+      if result["meta"]
+        return result["meta"]["pagination"]["total_records"]
+      else
+        puts "PlateApi: No success: #{result}"
         return nil
       end
     end

data/lib/plate_api/plate_object/base.rb

@@ -88,13 +88,21 @@ module PlateApi::PlateObject
 
     def self.has_many(plural_name, singular_name, klass, define_create_method=false)
       HasManyRelations[plural_name.to_s] = klass
-      define_has_many_method(plural_name, klass)
+      define_has_many_methods(plural_name, klass)
       define_create_method(singular_name, klass) if define_create_method
     end
 
-    def self.define_has_many_method(plural_name, klass)
+    def self.define_has_many_methods(plural_name, klass)
       define_method(plural_name.to_s) do |params={}|
-        @object_handler.api_connector.handler(Object.const_get(klass)).index(self.class, @id, params)
+        @object_handler.api_connector.handler(
+          Object.const_get(klass)
+        ).index(self.class, @id, params)
+      end
+
+      define_method("#{plural_name}_total_count") do
+        @object_handler.api_connector.handler(
+          Object.const_get(klass)
+        ).index_total_count(self)
       end
     end
 

data/lib/plate_api/version.rb

@@ -1,3 +1,3 @@
 module PlateApi
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/lib/plate_api.rb

@@ -12,4 +12,7 @@ require "plate_api/put_request"
 
 
 module PlateApi
+  def self.new(public_key, private_key)
+    PlateApi::Connector.new(public_key, secret_key)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plate_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - David Kortleven