New Version of Contentstack Ruby SDK

Author: rohitsharmabuiltio

.gitignore

@@ -1,11 +1,7 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/lib/debugger.rb
-/spec/reports/
-/tmp/
-.env
+contentstack-*
+build_doc.sh
+test
+doc
+spec-integration
+coverage
+\.yardoc

.rspec

@@ -0,0 +1,61 @@
+= 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}[/docs/Contentstack]
+
+
+== 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.

.travis.yml

@@ -1,47 +1,25 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'contentstack/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = "contentstack"
-  spec.version       = Contentstack::VERSION
-  spec.authors       = ["amite"]
-  spec.email         = ["amit.erandole@gmail.com"]
+require 'contentstack/version'
+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"]
 
-  spec.summary       = %q{A ruby gem to work with contentstack.built.io}
-  spec.description   = %q{A ruby gem to work with the Content Delivery API for contentstack.built.io}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  s.license = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "http://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
+  s.summary = %q{A ruby gem to work with Contentstack}
+  s.description = %q{A ruby gem to work with the Content Delivery API for contentstack}
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
 
-  spec.add_dependency 'typhoeus', '~> 1.1', '>= 1.1.2'
-  spec.add_dependency 'multi_json', '~> 1.12', '>= 1.12.1'
-  spec.add_dependency 'activesupport'
+  s.add_dependency 'activesupport', "> 3.2.5"
 
-  spec.add_development_dependency 'bundler', '~> 1.13', '>= 1.13.6'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.5'
-  spec.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.3'
-  spec.add_development_dependency 'awesome_print'
-  spec.add_development_dependency 'rb-readline'
-  spec.add_development_dependency 'byebug'
-  spec.add_development_dependency 'webmock', '~> 2.3', '>= 2.3.1'
-  spec.add_development_dependency 'dotenv', '~> 2.1', '>= 2.1.1'
-  spec.add_development_dependency 'yard'
-end
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+end