contentstack 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee5dd72d68bfd14e2292a7dd9bd18f0f11fe6091
-  data.tar.gz: 9903cbb89a02c2775a24a238727203c4d9ec9e10
+  metadata.gz: 1ba9cac23e4e20c7af32bb25d788cd226f489bb9
+  data.tar.gz: '0903ec191fca15f8664db5c9de793453657b3636'
 SHA512:
-  metadata.gz: df87832f6264b3ac38745dd5cd4364e89c61c50f817f1321c979fae7f9d38d1b32a560784abfaf2ceaf9e558b30ebe033290d778b1eeae4bae408e5b03a609aa
-  data.tar.gz: 9d98b68aae934eef4b344e1d19022d3c2b0ed795013f1023a322182588478d40f73fd6387d3b5887e22921d2620aceb5960b54bf4e9dff1e5caac6c9e32b7b4b
+  metadata.gz: '068954e3aac1861e09fe135fbcea77ac2fd528e8e295285bed5286026a1202fbd10f78f9418a7c1c5a8af14f8a9bfa107a7568567b9cb907c09374dae93415c3'
+  data.tar.gz: b38b4b0320cf45944edd04c6c0aed62578d9b029141f1b159f0dcf51e778a852623a4e06b270f11fdf5dd21613cdc41386614102c987426da2f9e02c2a202f1b

data/README.md

@@ -0,0 +1,100 @@
+# **Ruby SDK for Contentstack**
+
+Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. [Read More](https://www.contentstack.com/). 
+
+Contentstack provides Ruby SDK to build application on top of Ruby on Rails. Given below is the detailed guide and helpful resources to get started with our Ruby SDK.
+
+## **Prerequisite**
+
+You need ruby v2.0 or later installed to use the Contentstack Ruby SDK.
+
+## **Setup and Installation**
+
+Add the following code to your application's Gemfile and bundle:
+
+    gem 'contentstack'
+
+Or you can run this command in your terminal (you might need administrator privileges to perform this installation):
+
+    gem install contentstack
+
+To start using the SDK in your application, you will need to initialize the stack by providing the values for the keys given in the code snippet below.
+
+    client = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name")
+
+## **Key Concepts for using Contentstack**
+
+### **Stack**
+
+A stack is like a container that holds the content of your app. Learn more about [stacks](https://www.contentstack.com/docs/guide/stack).
+
+### **Content Type**
+
+Content type lets you define the structure or blueprint of a page or a section of your digital property. It is a form-like page that gives Content Managers an interface to input and upload content. [Read more](https://www.contentstack.com/docs/guide/content-types). 
+
+### **Entry**
+
+An entry is the actual piece of content created using one of the defined content types. Learn more about [Entries](https://www.contentstack.com/docs/guide/content-management#working-with-entries). 
+
+### **Asset**
+
+Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded to Contentstack. These files can be used in multiple entries. Read more about [Assets](https://www.contentstack.com/docs/guide/content-management#working-with-assets). 
+
+### **Environment**
+
+A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Learn how to work with [Environments](https://www.contentstack.com/docs/guide/environments). 
+
+## **Contentstack Ruby SDK: 5-minute Quickstart**
+
+### **Initializing your SDK **
+
+To initialize the SDK, you need to provide values for the keys given in the snippet below:
+
+    stack = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name")
+
+To get the API credentials mentioned above, log in to your Contentstack account and then in your top panel navigation, go to Settings > Stack to view the API Key and Access Token.
+
+### **Querying content from your stack**
+
+To fetch all entries of of a content type, use the query given below:
+
+    entry = stack.content_type(<<CONTENT_TYPE_UID>>).query();
+
+To fetch a specific entry from a content type, use the following query:
+
+    entry = stack.content_type(<<CONTENT_TYPE_UID>>).entry(<<ENTRY_UID>>);
+
+## **Advanced Queries**
+
+You can query for content types, entries, assets and more using our Ruby API Reference. 
+
+[Ruby API Reference Doc](http://www.rubydoc.info/gems/contentstack)
+
+## **Working with Images**
+
+We have introduced Image Delivery APIs that let you retrieve images and then manipulate and optimize them for your digital properties. It lets you perform a host of other actions such as crop, trim, resize, rotate, overlay, and so on. 
+
+For example, if you want to crop an image (with width as 300 and height as 400), you simply need to append query parameters at the end of the image URL, such as, https://images.contentstack.io/v3/assets/blteae40eb499811073/bltc5064f36b5855343/59e0c41ac0eddd140d5a8e3e/download?crop=300,400. There are several more parameters that you can use for your images. 
+
+[Read Image Delivery API documentation](https://www.contentstack.com/docs/apis/image-delivery-api/). 
+
+SDK functions for Image Delivery API coming soon. 
+
+## **Helpful Links**
+
+* [Contentstack Website](https://www.contentstack.com)
+
+* [Official Documentation](http://contentstack.com/docs)
+
+* [Content Delivery API Docs](https://contentstack.com/docs/apis/content-delivery-api/)
+
+## **The MIT License (MIT)**
+
+Copyright © 2012-2017 [Built.io](https://www.built.io/). All Rights Reserved
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/contentstack.gemspec

@@ -6,8 +6,10 @@ Gem::Specification.new do |s|
   s.name = %q{contentstack}
   s.version = Contentstack::VERSION.dup
   s.date = Time.now
-  s.authors = [%q{Rohit Sharma}]
-  s.email = ["rubygems@contentstack.com"]
+  s.authors = [%q{Contentstack}]
+  s.email = ["support@contentstack.com"]
+
+  s.required_ruby_version = '>= 2.0'
 
   s.license = "MIT"
   s.homepage = "https://github.com/builtio-contentstack/contentstack-ruby"

data/lib/contentstack/query.rb

@@ -370,6 +370,20 @@ module Contentstack
       self
     end
 
+    # Get entries from the specified locale. 
+    #
+    # @param [String] code The locale code of the entry
+    #
+    # Example
+    #    @query = @stack.content_type('category').query
+    #    @query.locale('en-us')
+    #
+    # @return [Contentstack::Query]
+    def locale(code)
+      @query[:locale] = code
+      self
+    end
+
     # Specifies an array of 'only' keys in BASE object that would be 'included' in the response.
     #
     # @param [Array] fields Array of the 'only' reference keys to be included in response.

data/lib/contentstack/version.rb

@@ -1,3 +1,3 @@
 module Contentstack
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/query_spec.rb

@@ -185,4 +185,9 @@ describe Contentstack::Query do
     data = category_query.or([q1,q2]).fetch
     expect(data.length).to eq 5
   end
+
+  it "should set locale the in the request query" do
+    data =  product_query.locale('en-us')
+    expect(data.query[:locale]).to eq 'en-us'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentstack
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
-- Rohit Sharma
+- Contentstack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-11 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -68,7 +68,7 @@ dependencies:
         version: '0'
 description: Contentstack Ruby client for the Content Delivery API
 email:
-- rubygems@contentstack.com
+- support@contentstack.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -77,7 +77,7 @@ files:
 - ".yardopts"
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
-- README.rdoc
+- README.md
 - contentstack.gemspec
 - coverage/.last_run.json
 - coverage/.resultset.json
@@ -148,7 +148,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -156,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Contentstack Ruby client for the Content Delivery API

data/README.rdoc

@@ -1,61 +0,0 @@
-= Contentstack Ruby SDK
-
-<i>Use Built.io Contentstack to power content for your Ruby projects</i>
-
-Create Ruby based applications and use the Ruby SDK to fetch and deliver content from Built.io Contentstack. The SDK uses Content Delivery APIs.
-
-== Getting Started
-
-This guide will help you get started with our Ruby SDK to build apps powered by Built.io Contentstack.
-
-=== SDK Installation and Setup
-
-To use the Ruby SDK, download it using the gem install command
-
-  $ gem install contentstack
-
-=== Initialize SDK
-
-You will need to specify the API key, Access token, and Environment Name of your stack to initialize the SDK:
-
-  @stack = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name")
-
-Once you have initialized the SDK, you can start getting content in your app.
-
-=== Basic Queries
-
-==== Get a Single Entry
-
-To get a single entry, you need to specify the content type as well as the uid of the entry.
-
-  entry = @stack.content_type('content_type_uid').entry("entry_uid").fetch
-  puts entry.get('title') # Use `get` method to retrieve field value by providing a field's unique ID
-
-==== Get Multiple Entries
-
-To retrieve multiple entries of a content type, you need to specify the content type uid. You can also specify search parameters to filter results.
-
-  @query = @stack.content_type('blog').query
-  @entries = @query.where('title', 'welcome')
-                   .include_schema
-                   .include_count
-                   .fetch
-
-  puts "Total Entries -- #{@entries.count}"
-  @entries.each{|entry| puts "#{entry.get('title')}" }
-
-
-== API Reference
-
-Go through our SDK API Reference guide to know about the methods that can be used to query your content in Built.io Contentstack.
-
-{Read Ruby SDK API Reference Guide}[http://www.rubydoc.info/gems/contentstack/0.0.1]
-
-
-== Example Apps
-
-To help you get started, we have created some sample applications that are powered by Built.io Contentstack Ruby SDK. Click on any of the links below to read the tutorials of the app, view app demo, or download the code from GitHub. 
-
-{Product Catalog}[#]
-
-Built.io Contentstack provides Ruby SDK using which you can create applications based on Ruby, or any other web frameworks created using Ruby.