contentful_model 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fd49f9a5ab20693fb5a3b33e2fa6060c26d748a
+  data.tar.gz: bfc894e3c1ecffe1b55b3bd70a6a61e65f46adf2
+SHA512:
+  metadata.gz: dc6c95c19d7fda48f82dbdfd5d4f701d689017bb5a47b992a5122132fcb114cfb933056ce287a75ce78d169e21f22075c9bbbd8341800a8f3da628578f83cf31
+  data.tar.gz: cdfa041cca206a8906469118311070fce55279290b001a26cd9293426c20ff0365b0e2d3615bee313d0f059e69f321f9f2414226d6c8818db5bc8a296e0d0778

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Error Creative Studio
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ContentfulModel'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/contentful_model/base.rb

@@ -0,0 +1,73 @@
+module ContentfulModel
+  class Base < Contentful::Entry
+    include ContentfulModel::ChainableQueries
+
+    def initialize(*args)
+      super
+      self.class.coercions ||= {}
+    end
+
+    #use method_missing to call fields on the model
+    def method_missing(method)
+      result = fields[:"#{method}"]
+      if result.nil?
+        raise NoMethodError, "No method or attribute #{method} for #{self}"
+      else
+        if self.class.coercions[method].nil?
+          return result
+        else
+          return self.class::COERCIONS[self.class.coercions[method]].call(result)
+        end
+      end
+    end
+
+    def cache_key(*timestamp_names)
+      if timestamp_names.present?
+        raise ArgumentError, "ContentfulModel::Base models don't support named timestamps."
+      end
+
+      "#{self.class.to_s.underscore}/#{self.id}-#{self.updated_at.utc.to_s(:number)}"
+
+    end
+
+    def save
+      raise NotImplementedError, "Saving models isn't implemented; we need to use the Contentful Management API for that. Pull requests welcome!"
+    end
+
+    alias_method :create, :save
+
+    class << self
+      attr_accessor :content_type_id, :coercions
+
+      def descendents
+        ObjectSpace.each_object(Class).select { |klass| klass < self }
+      end
+
+      def add_entry_mapping
+        unless ContentfulModel.configuration.entry_mapping.has_key?(@content_type_id)
+          ContentfulModel.configuration.entry_mapping[@content_type_id] = Object.const_get(self.to_s.to_sym)
+        end
+      end
+
+      def client
+        self.add_entry_mapping
+        @@client ||= Contentful::Client.new(ContentfulModel.configuration.to_hash)
+      end
+
+      def content_type
+        client.content_type(@content_type_id)
+      end
+
+      def coerce_field(coercions_hash)
+        self.coercions = coercions_hash
+      end
+
+    end
+
+
+
+
+
+
+  end
+end

data/lib/contentful_model/chainable_queries.rb

@@ -0,0 +1,74 @@
+module ContentfulModel
+  module ChainableQueries
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        cattr_accessor :query
+      end
+    end
+
+    module ClassMethods
+      def get_query
+        @query ||= ContentfulModel::Query.new(self)
+      end
+
+      def all
+        get_query
+        raise ArgumentError, "You need to set self.content_type in your model class" if @content_type_id.nil?
+        self
+      end
+
+      def first
+        get_query
+        @query << {'limit' => 1}
+        @query.execute.first
+      end
+
+      def offset(n)
+        get_query
+        puts @query.inspect
+        @query << {'skip' => n}
+        self
+      end
+
+      alias_method :skip, :offset
+
+      def find_by(*args)
+        get_query
+        args.each do |query|
+          #query is a hash
+          if query.values.first.is_a?(Array) #we need to do an 'in' query
+            @query << {"fields.#{query.keys.first}[in]" => query.values.first.join(",")}
+          else
+            @query << {"fields.#{query.keys.first}" => query.values.first}
+          end
+        end
+        self
+      end
+
+      def search(parameters)
+        get_query
+        if parameters.is_a?(Hash)
+          parameters.each do |field, search|
+            @query << {"fields.#{field}[match]" => search}
+          end
+        elsif parameters.is_a?(String)
+          @query << {"query" => parameters}
+        end
+        self
+      end
+
+      def load
+        @query.execute
+      end
+
+      def find(id)
+        get_query
+        @query << {'sys.id' => id}
+        @query.execute.first
+      end
+
+    end
+
+  end
+end

data/lib/contentful_model/query.rb

@@ -0,0 +1,17 @@
+module ContentfulModel
+  class Query
+    attr_accessor :parameters
+    def initialize(reference_class, parameters=nil)
+      @parameters = parameters || { 'content_type' => reference_class.content_type_id }
+      @client = reference_class.client
+    end
+
+    def <<(parameters)
+      @parameters.merge!(parameters)
+    end
+
+    def execute
+      @client.entries(@parameters)
+    end
+  end
+end

data/lib/contentful_model/version.rb

@@ -0,0 +1,3 @@
+module ContentfulModel
+  VERSION = "0.0.3"
+end

data/lib/contentful_model.rb

@@ -0,0 +1,42 @@
+require 'contentful'
+require "contentful_model/query"
+require "contentful_model/chainable_queries"
+require "contentful_model/base"
+require "active_support"
+
+module ContentfulModel
+  class << self
+    #access the configuration class as ContentfulModel.configuration
+    attr_accessor :configuration
+
+    #block for configuration.
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_accessor :access_token, :space, :entry_mapping
+
+    def initialize
+      @entry_mapping ||= {}
+    end
+
+    #Rather than listing out all the possible attributes as setters, we have a catchall
+    #called 'options' which takes a hash and generates instance vars
+    #@param options [Hash]
+    def options=(options)
+      options.each do |k,v|
+        instance_variable_set(:"@#{k}",v)
+      end
+    end
+
+
+    # Return the Configuration object as a hash, with symbols as keys.
+    # @return [Hash]
+    def to_hash
+      Hash[instance_variables.map { |name| [name.to_s.gsub("@","").to_sym, instance_variable_get(name)] } ]
+    end
+  end
+end

data/lib/tasks/contentful_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :contentful_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: contentful_model
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Error Creative Studio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contentful
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper around the Contentful gem to give you a base class to inherit
+  your models from
+email:
+- hosting@errorstudio.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- lib/contentful_model.rb
+- lib/contentful_model/base.rb
+- lib/contentful_model/chainable_queries.rb
+- lib/contentful_model/query.rb
+- lib/contentful_model/version.rb
+- lib/tasks/contentful_rails_tasks.rake
+homepage: https://github.com/errorstudio/contentful_model
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A thin wrapper for Contentful gem
+test_files: []