ncore 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 687bf7af7ae063bc540bc41c18ea36eada77d008
+  data.tar.gz: 9221a21313353c2921edcb6ce78835836fad2a66
+SHA512:
+  metadata.gz: 77cc977814f4adfa60276f2a9b3404e8804a37658c687ccaf1cf0e4c1cf4819bfaa72d8aeb1d691e58c37f922c1d6362c50865a4dd877da367d383ec6d7b2a08
+  data.tar.gz: 861663d398ace5c44bd3f8cf49257f7cef95e8127acf999895dc8dc300f37adc3b8fd45dcb8ff28e8b55d42d07e3ddb981343d9098b46195ff2238d523bf5844

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.tmproj
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ncore.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Notioneer, Inc.
+
+MIT License
+
+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.md

@@ -0,0 +1,36 @@
+# NCore
+
+NCore is a Ruby gem designed to help build REST API clients. It is not an API
+client by itself, but provides several useful building blocks to build one.
+
+It relies on `rest-client` for HTTP handling, `multi_json` for JSON parsing
+(and supports only JSON), and `activesupport`.
+
+See `example/` for the beginning of an actual api client.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ncore'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ncore
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/lib/my_api.rb

@@ -0,0 +1,12 @@
+require 'ncore'
+
+%w(version api_config).each do |f|
+  require "my_api/#{f}"
+end
+
+%w(customer).each do |f|
+  require "my_api/#{f}"
+end
+
+# optional; adds "MyApi: 16.3ms" to the Rails request log footer
+require 'my_api/rails/railtie' if defined?(Rails)

data/example/lib/my_api/api_config.rb

@@ -0,0 +1,33 @@
+module MyApi
+  include NCore::Builder
+
+  configure do
+    self.default_url = 'https://api.example.com/v1/'
+
+    self.default_headers = {
+      accept: 'application/json',
+      content_type: 'application/json',
+      user_agent: "MyApi/ruby v#{VERSION}"
+    }
+
+    if ENV['API_USER'] && ENV['API_KEY']
+      self.credentials = {
+        api_user: ENV['API_USER'],
+        api_key:  ENV['API_KEY']
+      }
+    end
+
+    self.debug = false
+
+    self.strict_attributes = false
+
+    self.instrument_key = 'request.my_api'
+
+    self.status_page = 'http://my.api.status.page'
+
+    self.auth_header_prefix = 'X-MyApi'
+
+    self.credentials_error_message = %Q{Missing API credentials. Set default credentials using "MyApi.credentials = {api_user: YOUR_API_USER, api_key: YOUR_API_KEY}"}
+  end
+
+end

data/example/lib/my_api/customer.rb

@@ -0,0 +1,8 @@
+module MyApi
+  class Customer < Resource
+    crud :all, :find, :create, :update, :delete
+
+    # has_many :users
+
+  end
+end

data/example/lib/my_api/rails/log_subscriber.rb

@@ -0,0 +1,10 @@
+require 'ncore/rails/log_subscriber'
+
+module AuthRocket
+  class LogSubscriber < ActiveSupport::LogSubscriber
+    include NCore::LogSubscriber
+    self.runtime_variable = 'myapi_runtime'
+  end
+end
+
+MyApi::LogSubscriber.attach_to :my_api

data/example/lib/my_api/rails/railtie.rb

@@ -0,0 +1,13 @@
+module MyApi
+  class Railtie < Rails::Railtie
+
+    initializer "my_api.log_runtime" do |app|
+      require 'my_api/rails/log_subscriber'
+      ActiveSupport.on_load(:action_controller) do
+        include NCore::ControllerRuntime
+        register_api_runtime MyApi::LogSubscriber, 'MyApi'
+      end
+    end
+
+  end
+end

data/example/lib/my_api/version.rb

@@ -0,0 +1,3 @@
+module MyApi
+  VERSION = "0.0.0"
+end

data/lib/ncore.rb

@@ -0,0 +1,14 @@
+require 'active_support/all'
+require 'excon'
+require 'multi_json'
+require 'pp'
+
+%w(version builder configuration associations attributes client collection exceptions identity lifecycle util base singleton_base).each do |f|
+  require "ncore/#{f}"
+end
+
+%w(all build count create delete delete_single find find_single update).each do |f|
+  require "ncore/methods/#{f}"
+end
+
+require 'ncore/rails/active_model' if defined?(::ActiveModel)

data/lib/ncore/associations.rb

@@ -0,0 +1,81 @@
+module NCore
+  module Associations
+
+    def has_many(assoc, klass=nil)
+      assoc = assoc.to_s
+      klass ||= "#{module_name}::#{assoc.camelize.singularize}"
+      key = "#{attrib_name}_id"
+      class_eval <<-M1, __FILE__, __LINE__+1
+        def #{assoc}(params={})
+          return [] unless id
+          reload = params.delete :reload
+          if params.empty?
+            # only cache unfiltered, default api call
+            @attribs[:#{assoc}] = (!reload && @attribs[:#{assoc}]) || #{klass}.all({#{key}: id}, api_creds)
+          else
+            #{klass}.all(params.merge(#{key}: id), api_creds)
+          end
+        end
+      M1
+      class_eval <<-M2, __FILE__, __LINE__+1
+        def find_#{assoc.singularize}(aid, params={})
+          raise UnsavedObjectError unless id
+          ## #{assoc}.detect{|o| o.id == aid} || raise(RecordNotFound)
+          # @attribs[:#{assoc}].detect{|o| o.id == aid} || #{klass}.find(aid, {#{key}: id}, api_creds)
+          #{klass}.find(aid, {#{key}: id}.reverse_merge(params), api_creds)
+        end
+      M2
+      # will always return the object; check .errors? or .valid? to see how it went
+      class_eval <<-M3, __FILE__, __LINE__+1
+        def create_#{assoc.singularize}(params={})
+          raise UnsavedObjectError unless id
+          #{klass}.create(params.merge(#{key}: id), api_creds)
+        end
+      M3
+      # will always return the object; check .errors? or .valid? to see how it went
+      class_eval <<-M4, __FILE__, __LINE__+1
+        def update_#{assoc.singularize}(aid, params={})
+          obj = find_#{assoc.singularize}(aid)
+          obj.update(params)
+          obj
+        end
+      M4
+      class_eval <<-M5, __FILE__, __LINE__+1
+        def create_#{assoc.singularize}!(params={})
+          raise UnsavedObjectError unless id
+          #{klass}.create!(params.merge(#{key}: id), api_creds)
+        end
+      M5
+      class_eval <<-M6, __FILE__, __LINE__+1
+        def update_#{assoc.singularize}!(aid, params={})
+          obj = find_#{assoc.singularize}(aid)
+          obj.save!(params)
+        end
+      M6
+    end
+
+    def belongs_to(assoc, klass=nil)
+      assoc = assoc.to_s
+      klass ||= "#{module_name}::#{assoc.camelize}"
+      class_eval <<-M1, __FILE__, __LINE__+1
+        attr :#{assoc}_id
+        def #{assoc}(params={})
+          return nil unless #{assoc}_id
+          if params.empty?
+            # only cache unfiltered, default api call
+            @attribs[:#{assoc}] ||= #{klass}.find(#{assoc}_id, {}, api_creds)
+          else
+            #{klass}.find(#{assoc}_id, params, api_creds)
+          end
+        end
+      M1
+      class_eval <<-M2, __FILE__, __LINE__+1
+        def #{assoc}_id=(v)
+          @attribs[:#{assoc}] = nil unless @attribs[:#{assoc}_id] == v
+          @attribs[:#{assoc}_id] = v
+        end
+      M2
+    end
+
+  end
+end

data/lib/ncore/attributes.rb

@@ -0,0 +1,157 @@
+module NCore
+  module Attributes
+    extend ActiveSupport::Concern
+
+    included do
+      attr :id
+    end
+
+
+    module ClassMethods
+      def attr(*attrs)
+        attrs.each do |attr|
+          class_eval <<-AR, __FILE__, __LINE__+1
+            def #{attr}
+              self[:#{attr}]
+            end
+          AR
+        end
+      end
+
+      def attr_datetime(*attrs)
+        attrs.each do |attr|
+          class_eval <<-AD, __FILE__, __LINE__+1
+            def #{attr}
+              case self[:#{attr}]
+              when String
+                Time.parse(self[:#{attr}]).utc
+              when Numeric
+                Time.at(self[:#{attr}]).utc
+              else
+                self[:#{attr}]
+              end
+            rescue ArgumentError, TypeError
+              self[:#{attr}]
+            end
+          AD
+        end
+      end
+
+      def attr_decimal(*attrs)
+        attrs.each do |attr|
+          class_eval <<-AD, __FILE__, __LINE__+1
+            def #{attr}
+              case self[:#{attr}]
+              when String
+                BigMoney.new(self[:#{attr}])
+              else
+                self[:#{attr}]
+              end
+            end
+          AD
+        end
+      end
+    end
+
+
+    attr_accessor :api_creds
+    attr_accessor :metadata, :errors
+
+
+    def initialize(attribs={}, api_creds=nil)
+      @attribs = {}.with_indifferent_access
+      @api_creds = api_creds
+
+      attribs = attribs.dup.with_indifferent_access
+      if attribs.keys.sort == %w(data error metadata)
+        load_attrs = attribs
+      else
+        load_attrs = {
+          metadata: attribs.delete(:metadata),
+          errors: attribs.delete(:errors),
+          data: attribs.delete(:data) || attribs
+        }
+      end
+      load(load_attrs)
+    end
+
+
+    def attributes
+      Util.deep_clone(@attribs)
+    end
+
+
+    def [](attr)
+      @attribs[attr]
+    end
+
+
+    # Method names known to cause strange behavior in other libraries
+    # where said libraries check for these methods to determine other
+    # behavior.
+    KNOWN_FALSE_TRIGGERS = %w(map each)
+
+    def respond_to?(method, incl_private=false)
+      m2 = method.to_s.sub(/(\?)$/,'')
+      if method.to_s =~ /\=$/
+        super
+      elsif @attribs.has_key?(m2)
+        true
+      elsif !self.class.strict_attributes && !KNOWN_FALSE_TRIGGERS.include?(m2)
+        true
+      else
+        super
+      end
+    end
+
+
+    private
+
+    def method_missing(method, *args, &block)
+      case method.to_s
+      when /(.+)\?$/
+        if @attribs.has_key?($1) || respond_to?($1.to_sym)
+          !! self[$1]
+        else
+          super
+        end
+      when /\=$/
+        super
+      else
+        if @attribs.has_key?(method) || !self.class.strict_attributes
+          self[method]
+        else
+          super
+        end
+      end
+    end
+
+
+    def load(parsed)
+      self.metadata = parsed[:metadata] || {}.with_indifferent_access
+      self.errors = parsed[:errors] || {}.with_indifferent_access
+      parsed[:data].each do |k,v|
+        if respond_to? "#{k}="
+          send "#{k}=", self.class.interpret_type(v, api_creds)
+        else
+          @attribs[k] = self.class.interpret_type(v, api_creds)
+        end
+      end
+      self
+    end
+
+  end
+
+
+  class BigMoney < BigDecimal
+
+    def to_s
+      if (self % BigDecimal.new('0.01')) == 0
+        '%.2f' % self
+      else
+        super
+      end
+    end
+
+  end
+end

data/lib/ncore/base.rb

@@ -0,0 +1,35 @@
+module NCore
+  module Base
+    extend ActiveSupport::Concern
+    
+    included do
+      extend Associations
+      include Attributes
+      include Client
+      include Identity
+      include Lifecycle
+      include Util
+    end
+
+    module ClassMethods
+      def crud(*types)
+        include All    if types.include? :all
+        include Build  if types.include? :build
+        include Count  if types.include? :count
+        include Create if types.include? :create
+        include Delete if types.include? :delete
+        include Find   if types.include? :find
+        include Update if types.include? :update
+      end
+
+      def url
+        class_name.underscore.pluralize
+      end
+    end
+
+    def url
+      "#{self.class.url}/#{CGI.escape id||'-'}"
+    end
+
+  end
+end