Sha256: 336d6eba607e314b959a739e48c91fc26d007bbe09d8314750b96b03f310e2e6

Contents?: true

Size: 1.16 KB

Versions: 39

Compression:

Stored size: 1.16 KB

Contents

.alert.alert-info
  | <a href="https://github.com/locomotivecms/coal"><strong>Coal</strong></a> is our Ruby API client for Locomotive. You can still use curl to fetch our Restful API. See our <a href="http://doc.locomotivecms.com" />documentation site</a> for more information.

h3 Install Coal

pre
  code.bash
    | gem install locomotivecms_coal --pre

h3 Authentication

p Load the gem

pre
  code.ruby
    | require 'locomotive/coal'

p Authenticate

pre
  code.ruby
    | client = Locomotive::Coal::Client.new('#{current_request_url}', { email: '#{current_locomotive_account.email}', api_key: '#{current_locomotive_account.api_key}' })

p Set the site context

pre
  code.ruby
    | site_client = client.scope_by('#{current_site.handle}')

h3 Get the name of the site and update it

pre
  code.ruby
    | puts "Old name is \#{site_client.current_site.get.name}"<br/>
    | site_client.current_site.update name: "A better #{current_site.name}"

- current_site.content_types.each do |content_type|
  h3 Get entries of the #{content_type.name} model

  p Example: get the first 10 entries

  pre
    code.ruby
      | #{content_type.slug} = site_client.contents.#{content_type.slug}.all

Version data entries

39 entries across 39 versions & 1 rubygems

Version Path
locomotivecms-4.2.0.alpha2 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.2.0.alpha1 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.1.1 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.1.0 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.1.0.rc1 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.0.3 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.0.2 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.0.1 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.0.0 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.0.0.rc0 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.0.0.alpha3 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-3.4.1 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.0.0.alpha2 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-4.0.0.alpha1 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-3.4.0 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-3.3.0 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-3.3.0.rc3 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-3.3.0.rc2 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-3.1.2 app/views/locomotive/developers_documentation/_api.html.slim
locomotivecms-3.2.1 app/views/locomotive/developers_documentation/_api.html.slim