contentstack 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee5dd72d68bfd14e2292a7dd9bd18f0f11fe6091
+  data.tar.gz: 9903cbb89a02c2775a24a238727203c4d9ec9e10
+SHA512:
+  metadata.gz: df87832f6264b3ac38745dd5cd4364e89c61c50f817f1321c979fae7f9d38d1b32a560784abfaf2ceaf9e558b30ebe033290d778b1eeae4bae408e5b03a609aa
+  data.tar.gz: 9d98b68aae934eef4b344e1d19022d3c2b0ed795013f1023a322182588478d40f73fd6387d3b5887e22921d2620aceb5960b54bf4e9dff1e5caac6c9e32b7b4b

data/.gitignore

@@ -0,0 +1,7 @@
+contentstack-*
+build_doc.sh
+test
+doc
+spec-integration
+coverage
+\.yardoc

data/.yardopts

@@ -0,0 +1,6 @@
+README.rdoc
+lib/contentstack/*
+lib/contentstack.rb
+--exclude lib/contentstack/util.rb
+--exclude lib/contentstack/api.rb
+--exclude lib/contentstack/version.rb

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at amit.erandole@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 amite
+
+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/README.rdoc

@@ -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}[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.

data/contentstack.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+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"]
+
+  s.license = "MIT"
+  s.homepage = "https://github.com/builtio-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}
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'activesupport', "> 3.2.5"
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+end

data/lib/contentstack.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require "contentstack/version"
+require "contentstack/client"
+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.
+# == Installation
+#   gem install contentstack
+# == Initialize the Stack
+#   @stack = Contentstack::Client.new("site_api_key", "access_token", "enviroment_name")
+# == Usage
+# ==== Get single entry
+#   @stack.content_type('blog').entry('<entry_uid_here>').fetch
+# ==== Query entries
+#   @stack.content_type('blog').query.regex('title', '.*hello.*').fetch
+module Contentstack
+end

data/lib/contentstack/api.rb

@@ -0,0 +1,54 @@
+require 'uri'
+require 'net/http'
+require 'active_support'
+require 'active_support/json'
+require 'open-uri'
+
+module Contentstack
+  class API
+    def self.init_api(api_key, access_token, environment)
+      @host = "https://cdn.contentstack.io"
+      @api_version = '/v3'
+      @environment = environment
+      @headers = {api_key: api_key, access_token: access_token, user_agent: "ruby-sdk/#{Contentstack::VERSION}", environment: @environment}
+    end
+
+    def self.fetch_content_types(uid="")
+      if !uid.nil? && !uid.empty?
+        path = "/content_types/#{uid}"
+      else
+        path = "/content_types"
+      end
+      send_request(path, {})
+    end
+
+    def self.fetch_entries(content_type, query)
+      path = "/content_types/#{content_type}/entries"
+      send_request(path, query)
+    end
+
+    def self.fetch_entry(content_type, entry_uid)
+      path = "/content_types/#{content_type}/entries/#{entry_uid}"
+      send_request(path)
+    end
+
+    def self.get_assets(asset_uid=nil)
+      path = "/assets"
+      path += "/#{asset_uid}" if !asset_uid.nil?
+      send_request(path)
+    end
+
+    private
+    def self.send_request(path, q=nil)
+      q ||= {}
+
+      q.merge!(@headers)
+      q.merge!({timestamp: Time.now.to_i})
+
+      query = "?" + q.to_query
+      # puts "Request URL:- #{@host}#{@api_version}#{path}#{query} \n\n"
+      
+      ActiveSupport::JSON.decode(open("#{@host}#{@api_version}#{path}#{query}").read)
+    end
+  end
+end

data/lib/contentstack/asset.rb

@@ -0,0 +1,67 @@
+module Contentstack
+
+  # Asset class to fetch file details on Conentstack server.
+  class Asset
+    attr_reader :uid, :content_type, :filename, :file_size, :tags, :url
+
+    # @!attribute [r] uid
+    #   Contentstack Asset UID for this asset
+
+    # @!attribute [r] content_type
+    #   Content Type for the asset. image/png, image/jpeg, application/pdf, video/mp4 etc.
+
+    # @!attribute [r] filename
+    #   Name of the asset.
+
+    # @!attribute [r] file_size
+    #   Size of the asset.
+
+    # @!attribute [r] tags
+    #   Array of tags assigned to the asset.
+
+    # @!attribute [r] url
+    #   URL to fetch/render the asset
+
+    # Create instance of an Asset. Accepts either a uid of asset (String) or a complete asset JSON
+    # @param [String/Hash] attrs
+    # Usage for String parameter
+    #   @asset = @stack.asset("some_asset_uid")
+    #   @asset.fetch
+    #
+    # Usage for Hash parameter
+    #   @asset = @stack.asset({
+    #     :uid          => "some_asset_uid",
+    #     :content_type => "file_type", # image/png, image/jpeg, application/pdf, video/mp4 etc.
+    #     :filename    => "some_file_name",
+    #     :file_size    => "some_file_size",
+    #     :tags         => ["tag1", "tag2", "tag3"],
+    #     :url          => "file_url"
+    #   })
+    #   @asset.fetch
+    def initialize(attrs)
+      if attrs.class == String
+        @uid = attrs
+      else
+        attrs = attrs.symbolize_keys
+        @uid = attrs[:uid]
+        @content_type = attrs[:content_type]
+        @filename = attrs[:filename]
+        @file_size = attrs[:file_size]
+        @tags = attrs[:tags]
+        @url = attrs[:url]
+      end
+
+      self
+    end
+
+    # Fetch a particular asset using uid.
+    #   @asset = @stack.asset('some_asset_uid')
+    #   @asset.fetch
+    #   puts @asset.url
+    def fetch
+      json = API.get_assets(@uid)
+      # puts "json -- #{json}"
+      self.class.new(json["asset"])
+    end
+  end
+end

data/lib/contentstack/asset_collection.rb

@@ -0,0 +1,26 @@
+require 'contentstack/asset'
+
+module Contentstack
+  # Asset class to fetch details of files on Conentstack server.
+  class AssetCollection
+    attr_reader :assets
+
+    def initialize(assets_array=nil)
+      if assets_array.nil?
+        @assets = []
+        return self
+      else
+        @assets = assets_array.collect{|a| Asset.new(a)}
+      end
+    end
+
+    # Fetch assets uploaded to Contentstack
+    #
+    # Example:
+    #    @assets = @stack.assets.fetch
+    def fetch
+      json = API.get_assets
+      self.class.new(json["assets"])
+    end
+  end
+end

data/lib/contentstack/client.rb

@@ -0,0 +1,29 @@
+require 'contentstack/api'
+require 'contentstack/content_type'
+require 'contentstack/asset_collection'
+
+module Contentstack
+  class Client
+    # Initialize "Built.io Contentstack" Client instance
+    def initialize(api_key, access_token, environment)
+      API.init_api(api_key, access_token, environment)
+    end
+
+    
+    def content_types
+      ContentType.all
+    end
+
+    def content_type(uid)
+      ContentType.new({uid: uid})
+    end
+
+    def assets
+      AssetCollection.new
+    end
+
+    def asset(uid)
+      Asset.new(uid)
+    end
+  end
+end

data/lib/contentstack/content_type.rb

@@ -0,0 +1,52 @@
+require 'contentstack/query'
+
+module Contentstack
+  class ContentType
+    [:title, :uid, :created_at, :updated_at, :attributes].each do |method_name|
+      if [:created_at, :updated_at].include?(method_name)
+        define_method method_name do
+          return Time.parse(@attributes[method_name]) if @attributes[method_name] && !@attributes[method_name].nil?
+        end
+      elsif :attributes == method_name
+        define_method :attributes do
+          {
+            title: self.title,
+            uid: self.uid,
+            created_at: self.created_at,
+            updated_at: self.updated_at,
+            schema: @attributes[:schema]
+          }
+        end 
+      else
+        define_method method_name do
+          return @attributes[method_name]
+        end
+      end
+    end
+
+    def initialize(object)
+      @attributes = object.symbolize_keys
+    end
+
+    def query
+      Query.new(self.uid)
+    end
+
+    def entry(entry_uid)
+      Entry.new({uid: entry_uid}, self.uid)
+    end
+
+
+    def self.all
+      content_types = API.fetch_content_types["content_types"]
+      content_types.map do |content_type|
+        ContentType.new(content_type.inject({}){|clone,(k,v)| clone[k.to_sym] = v; clone})
+      end
+    end
+
+    def self.find_by_uid(uid)
+      content_type = API.fetch_content_types(uid)["content_type"]
+      ContentType.new(content_type.inject({}){|clone,(k,v)| clone[k.to_sym] = v; clone})
+    end
+  end
+end