contentstack 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2c05a60239a20793be053c9afa3684e579f1b744
-  data.tar.gz: 002d29d76b307264a6353cb13b6a7d07a5372d35
+SHA256:
+  metadata.gz: cc7aab29132806e94f049f49be18f7bbb285423f13a949dfc6ea8288d4d52a51
+  data.tar.gz: d290838ee0df496dedf6cc1912fd180cc646b018041bac733afccce190a9dd24
 SHA512:
-  metadata.gz: 3fa5770932d3c6e4de5dbb6c90790f3ae889802863403c45a4aff7338d1ca591ec72e6920798fb81f85c3c745ef33e770898e852e3ad68bf9c490b356a957a17
-  data.tar.gz: 63b98d912dcbf97dc4b1e34f326ef125a53fcccdb1748211126ff4a3f311ab5d65d762216703a8fdda46cb8c3a2871d16d210c323561373bdad6cdf76cd76f31
+  metadata.gz: ff4947a727bcb0f195c7e9712b6072192942c2de8be5edfc420ec16176924eaf24f61ddef3ee13dca2659d1c5c3abefe598dbf43efee9ae1e81d9571dcddad3f
+  data.tar.gz: 9625bc07c44f7cc31d7f43212fc3f9cb9cfe108063b894e9cd17d1c49fa8b45d68f37d828796333448033c8d05db2cdd8ab4e02693e34db3e70cd51f56cf45bf

data/.gitignore

@@ -5,3 +5,6 @@ doc
 spec-integration
 coverage
 \.yardoc
+.DS_Store
+.bundle/
+*/rspec_results.html

data/Gemfile

@@ -0,0 +1,7 @@
+# Gemfile
+source "https://rubygems.org"
+
+gem "rspec"
+gem "webmock"
+gem "simplecov"
+gem "activesupport"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    concurrent-ruby (1.1.6)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    hashdiff (1.0.1)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    public_suffix (4.0.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    safe_yaml (1.0.5)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    webmock (3.8.3)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  rspec
+  simplecov
+  webmock
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -22,13 +22,13 @@ Or you can run this command in your terminal (you might need administrator privi
 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.
 
     # with default region
-    client = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name")
+    client = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name")
     
     # with specific region
-    client = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name",{"region": Contentstack::Region::EU})
+    client = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name",{"region": Contentstack::Region::EU})
     
     # with custom host
-    client = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name",{"host": "https://custom-cdn.contentstack.com"})
+    client = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name",{"host": "https://custom-cdn.contentstack.com"})
 
 
 
@@ -61,7 +61,7 @@ A publishing environment corresponds to one or more deployment servers or a cont
 
 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")
+    stack = Contentstack::Client.new("site_api_key", "delivery_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.
 
@@ -101,7 +101,7 @@ SDK functions for Image Delivery API coming soon.
 
 ## **The MIT License (MIT)**
 
-Copyright © 2012-2019 [Contentstack](https://www.contentstack.com). All Rights Reserved
+Copyright © 2012-2020 [Contentstack](https://www.contentstack.com). 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:
 

data/contentstack.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0'
 
   s.license = "MIT"
-  s.homepage = "https://github.com/builtio-contentstack/contentstack-ruby"
+  s.homepage = "https://github.com/contentstack/contentstack-ruby"
 
   s.summary = %q{Contentstack Ruby client for the Content Delivery API}
   s.description = %q{Contentstack Ruby client for the Content Delivery API}

data/lib/contentstack.rb

@@ -6,16 +6,16 @@ require "contentstack/region"
 require "util"
 
 
-# == Built.io Contentstack - Ruby SDK
-# Built.io Contentstack is a content management system that facilitates the process of publication by separating the content from site-related programming and design.
+# == Contentstack - Ruby SDK
+# Contentstack is a content management system that facilitates the process of publication by separating the content from site-related programming and design.
 # == Installation
 #   gem install contentstack
 # == Initialize the Stack
-#   @stack = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name")
+#   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name")
 # == Initialize the Stack for EU region
-#   @stack = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name", {"region": Contentstack::Region::EU })
+#   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name", {"region": Contentstack::Region::EU })
 # == Initialize the Stack for custom host
-#   @stack = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name", {"host": "https://custom-cdn.contentstack.com" })
+#   @stack = Contentstack::Client.new("site_api_key", "delivery_token", "enviroment_name", {"host": "https://custom-cdn.contentstack.com" })
 # == Usage
 # ==== Get single entry
 #   @stack.content_type('blog').entry('<entry_uid_here>').fetch

data/lib/contentstack/api.rb

@@ -6,11 +6,13 @@ require 'open-uri'
 
 module Contentstack
   class API
-    def self.init_api(api_key, access_token, environment,host)
+    def self.init_api(api_key, delivery_token, environment,host)
       @host = host
       @api_version = '/v3'
       @environment = environment
-      @headers = {api_key: api_key, access_token: access_token, user_agent: "ruby-sdk/#{Contentstack::VERSION}", environment: @environment}
+      @api_key = api_key
+      @access_token = delivery_token
+      @headers = {environment: @environment}
     end
 
     def self.fetch_content_types(uid="")
@@ -47,7 +49,11 @@ module Contentstack
       query = "?" + q.to_query
       # puts "Request URL:- #{@host}#{@api_version}#{path}#{query} \n\n"
       
-      ActiveSupport::JSON.decode(open("#{@host}#{@api_version}#{path}#{query}").read)
+      ActiveSupport::JSON.decode(open("#{@host}#{@api_version}#{path}#{query}",
+      "api_key" =>  @api_key,
+      "access_token"=>  @access_token,
+      "user_agent"=> "ruby-sdk/#{Contentstack::VERSION}",
+      "x-user-agent" => "ruby-sdk/#{Contentstack::VERSION}").read)
     end
   end
-end
+end

data/lib/contentstack/client.rb

@@ -5,11 +5,11 @@ require 'contentstack/asset_collection'
 module Contentstack
   class Client
     attr_reader :region, :host
-    # Initialize "Built.io Contentstack" Client instance
-    def initialize(api_key, access_token, environment, options={})
+    # Initialize "Contentstack" Client instance
+    def initialize(api_key, delivery_token, environment, options={})
       @region = options[:region].nil? ? Contentstack::Region::US : options[:region]
       @host = options[:host].nil? ? get_default_region_hosts(@region) : options[:host]
-      API.init_api(api_key, access_token, environment,  @host)
+      API.init_api(api_key, delivery_token, environment,  @host)
     end
 
     

data/lib/contentstack/entry.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext'
+
 module Contentstack
   class Entry
     attr_reader :fields, :content_type, :uid, :owner

data/lib/contentstack/version.rb

@@ -1,3 +1,3 @@
 module Contentstack
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/content_type_spec.rb

@@ -3,8 +3,8 @@ require_relative '../lib/contentstack.rb'
 
 describe Contentstack::ContentType do
   let(:client) { create_client }
-  let(:eu_client) { create_client('ACCESS_TOKEN', 'API_KEY', 'STACK_ENV', {region: Contentstack::Region::EU}) }
-  let(:custom_host_client) { create_client('ACCESS_TOKEN', 'API_KEY', 'STACK_ENV', {host: "https://custom-cdn.contentstack.com"}) }
+  let(:eu_client) { create_client('DELIVERY_TOKEN', 'API_KEY', 'STACK_ENV', {region: Contentstack::Region::EU}) }
+  let(:custom_host_client) { create_client('DELIVERY_TOKEN', 'API_KEY', 'STACK_ENV', {host: "https://custom-cdn.contentstack.com"}) }
 
   describe "Fetch data from API" do
     it "has class as Contentstack::ContentType" do

data/spec/contentstack_spec.rb

@@ -3,8 +3,8 @@ require_relative '../lib/contentstack.rb'
 
 describe Contentstack do
   let(:client) { create_client }
-  let(:eu_client) { create_client('ACCESS_TOKEN', 'API_KEY', 'STACK_ENV', {region: Contentstack::Region::EU}) }
-  let(:custom_host_client) { create_client('ACCESS_TOKEN', 'API_KEY', 'STACK_ENV', {host: "https://custom-cdn.contentstack.com"}) }
+  let(:eu_client) { create_client('DELIVERY_TOKEN_TOKEN', 'API_KEY', 'STACK_ENV', {region: Contentstack::Region::EU}) }
+  let(:custom_host_client) { create_client('DELIVERY_TOKEN_TOKEN', 'API_KEY', 'STACK_ENV', {host: "https://custom-cdn.contentstack.com"}) }
 
   it "has a version number" do
     expect(Contentstack::VERSION).not_to be nil

data/spec/spec_helper.rb

@@ -148,7 +148,7 @@ RSpec.configure do |config|
       to_return(:status => 200, :body => File.read(File.dirname(__FILE__) + '/fixtures/category_entry.json'), :headers => {})
   end
 
-  def create_client(access_token = ENV['ACCESS_TOKEN'], api_key = ENV['API_KEY'], environment = ENV['STACK_ENV'], options = {})
-    Contentstack::Client.new(access_token, api_key, environment, options)
+  def create_client(delivery_token = ENV['ACCESS_TOKEN'], api_key = ENV['API_KEY'], environment = ENV['STACK_ENV'], options = {})
+    Contentstack::Client.new(delivery_token, api_key, environment, options)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contentstack
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Contentstack
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-03 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,6 +76,8 @@ files:
 - ".gitignore"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - contentstack.gemspec
@@ -137,7 +139,7 @@ files:
 - spec/fixtures/product_entry_collection.json
 - spec/query_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/builtio-contentstack/contentstack-ruby
+homepage: https://github.com/contentstack/contentstack-ruby
 licenses:
 - MIT
 metadata: {}
@@ -156,8 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Contentstack Ruby client for the Content Delivery API