chartmogul-ruby 0.1.1

data/lib/chartmogul/object.rb

@@ -0,0 +1,119 @@
+require 'set'
+
+module ChartMogul
+  class Object
+    class << self
+      def attributes
+        @attributes ||= Set.new
+      end
+
+      def writeable_attributes
+        @writeable_attributes ||= Set.new
+      end
+
+      def readonly_attr(attribute, options = {})
+        attributes << attribute.to_sym
+        define_reader(attribute, options[:default])
+        define_private_writer(attribute, options[:type])
+      end
+
+      def writeable_attr(attribute, options = {})
+        attributes << attribute.to_sym
+        writeable_attributes << attribute.to_sym
+
+        define_reader(attribute, options[:default])
+        define_writer(attribute)
+        define_private_writer(attribute, options[:type])
+      end
+
+      def define_reader(attribute, default)
+        define_method(attribute) do
+          if instance_variable_defined?("@#{attribute}")
+            instance_variable_get("@#{attribute}")
+          else
+            instance_variable_set("@#{attribute}", default)
+          end
+        end
+      end
+
+      def define_private_writer(attribute, type)
+        if type == :time
+          define_method("set_#{attribute}") do |value|
+            instance_variable_set("@#{attribute}", value && Time.parse(value))
+          end
+        elsif type == :date
+          define_method("set_#{attribute}") do |value|
+            instance_variable_set("@#{attribute}", value && Date.strptime(value, '%Y-%m-%d'))
+          end
+        else
+          define_method("set_#{attribute}") do |value|
+            instance_variable_set("@#{attribute}", value)
+          end
+        end
+        private "set_#{attribute}"
+      end
+
+      def define_writer(attribute)
+        define_method("#{attribute}=") do |value|
+          instance_variable_set("@#{attribute}", value)
+        end
+      end
+    end
+
+    def initialize(attributes = {})
+      assign_writeable_attributes(attributes)
+    end
+
+    def self.new_from_json(attributes={})
+      self.new.tap do |resource|
+        resource.assign_all_attributes(attributes)
+      end
+    end
+
+    def instance_attributes
+      self.class.attributes.each_with_object({}) do |attribute, hash|
+        hash[attribute] = send(attribute)
+      end
+    end
+
+    def assign_writeable_attributes(new_values)
+      self.class.writeable_attributes.each do |attr, value|
+        self.send("#{attr}=", new_values[attr]) if new_values.key?(attr)
+      end
+
+      self
+    end
+
+    def assign_all_attributes(new_values)
+      self.class.attributes.each do |attr|
+        self.send("set_#{attr}", new_values[attr]) if new_values.key?(attr)
+      end
+
+      self
+    end
+
+    def serialize_for_write
+      self.class.writeable_attributes.each_with_object({}) do |attr, attrs|
+        serialized_value = serialized_value_for_attr(attr)
+        attrs[attr] = serialized_value if allowed_for_write?(serialized_value)
+      end
+    end
+
+    def allowed_for_write?(serialized_value)
+      return false if serialized_value.is_a?(Array) && serialized_value.empty?
+      return false if serialized_value.nil?
+
+      true
+    end
+
+    def serialized_value_for_attr(attr)
+      serialize_method_name = "serialize_#{attr}"
+
+      if respond_to?(serialize_method_name)
+        send(serialize_method_name)
+      else
+        send(attr)
+      end
+    end
+  end
+end

data/lib/chartmogul/resource_path.rb

@@ -0,0 +1,42 @@
+require 'uri'
+
+module ChartMogul
+  class ResourcePath
+    attr_reader :path
+    attr_reader :named_params
+
+    class RequiredParameterMissing < StandardError; end
+
+    def initialize(path)
+      @path = path
+      @named_params = path.scan(/:\w+/).each_with_object({}) do |named_param, hash|
+        hash[named_param] = named_param.gsub(':', '').to_sym
+      end
+    end
+
+    def apply(params = {})
+      apply_named_params(params)
+    end
+
+    # For path = '/hello/:hello_id/say' & params = { hello_id: 1, search: 'cat' }
+    # it will return '/hello/1/say?search=cat'
+
+    def apply_with_get_params(params = {})
+      base_path = apply_named_params(params)
+      get_params = params.reject { |param_name| named_params.values.include?(param_name) }
+
+      get_params.empty? ? base_path : "#{base_path}?#{URI.encode_www_form(get_params)}"
+    end
+
+    private
+
+    def apply_named_params(params)
+      path.dup.tap do |path|
+        named_params.each do |named_param, param_key|
+          raise(RequiredParameterMissing, "#{named_param} is required") unless params.key?(param_key)
+          path.gsub!(named_param, params[param_key].to_s)
+        end
+      end
+    end
+  end
+end

data/lib/chartmogul/summary.rb

@@ -0,0 +1,7 @@
+module ChartMogul
+  class Summary < ChartMogul::Object
+    readonly_attr :current
+    readonly_attr :previous
+    readonly_attr :percentage_change
+  end
+end

data/lib/chartmogul/utils/hash_snake_caser.rb

@@ -0,0 +1,50 @@
+module ChartMogul
+  module Utils
+    class HashSnakeCaser
+      #
+      # Recursively converts CamelCase and camelBack JSON-style hash keys to
+      # Rubyish snake_case, suitable for use during instantiation of Ruby
+      # model attributes.
+      #
+      def initialize(hash)
+        @hash = hash
+      end
+
+      def to_snake_keys(value = @hash)
+        case value
+        when Array
+          value.map { |v| to_snake_keys(v) }
+        when Hash
+          snake_hash(value)
+        else
+          value
+        end
+      end
+
+      private
+
+      def snake_hash(value)
+        Hash[value.map { |k, v| [underscore_key(k), to_snake_keys(v)] }]
+      end
+
+      def underscore_key(k)
+        if k.instance_of?(Symbol)
+          underscore(k.to_s).to_sym
+        elsif k.instance_of?(String)
+          underscore(k)
+        else
+          k # Can't snakify anything except strings and symbols
+        end
+      end
+
+      def underscore(string)
+        string.gsub(/::/, '/')
+          .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+          .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+          .tr('-', '_')
+          .downcase
+      end
+    end
+  end
+end
+

data/lib/chartmogul/utils/json_parser.rb

@@ -0,0 +1,11 @@
+module ChartMogul
+  module Utils
+    class JSONParser
+      def self.parse(json_string)
+        hash = JSON.parse(json_string, symbolize_names: true)
+        HashSnakeCaser.new(hash).to_snake_keys
+      end
+    end
+  end
+end
+

data/lib/chartmogul/version.rb

@@ -0,0 +1,3 @@
+module ChartMogul
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: chartmogul-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jason Langenauer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+description: Official Ruby client for ChartMogul's API
+email:
+- jason@chartmogul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ChartMogul_Metrics_MRRChurnRate/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
+- ChartMogul_Metrics_MRRChurnRate/behaves_like_Metrics_API_resource/should_have_entries.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changelog.md
+- chartmogul-ruby.gemspec
+- fixtures/vcr_cassettes/ChartMogul_DataSource/API_Interactions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_DataSource/API_Interactions/correctly_raises_errors_on_404.yml
+- fixtures/vcr_cassettes/ChartMogul_DataSource/API_Interactions/correctly_raises_errors_on_422.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/adds_custom_attributes.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/adds_required_tags.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/raises_404_if_no_customers_found.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/removes_custom_attributes.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/removes_tags.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/returns_all_customers_through_list_all_endpoint.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/returns_customer_through_retrieve_endpoint.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/returns_right_customers_through_search_endpoint.yml
+- fixtures/vcr_cassettes/ChartMogul_Enrichment_Customer/API_Interactions/updates_custom_attributes.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_Customer/API_Interactions/correctly_handles_a_422_response.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_Customer/API_Interactions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_CustomerInvoices/API_Interactions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_DataSource/API_Interactions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_DataSource/API_Interactions/correctly_raises_errors_on_404.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_DataSource/API_Interactions/correctly_raises_errors_on_422.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_Plan/API_Interractions/correctly_handles_a_422_error.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_Plan/API_Interractions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_Subscription/API_Interactions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_Import_Transactions_Payment/API_Interactions/correctly_interracts_with_the_API.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_ARPA/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_ARPA/behaves_like_Metrics_API_resource/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_ARR/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_ARR/behaves_like_Metrics_API_resource/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_ASP/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_ASP/behaves_like_Metrics_API_resource/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Activity/behaves_like_Pageable/should_be_pageable.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Activity/should_have_Activity_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_AllKeyMetric/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_CustomerChurnRate/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_CustomerChurnRate/behaves_like_Metrics_API_resource/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_CustomerCount/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_CustomerCount/behaves_like_Metrics_API_resource/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_LTV/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_LTV/behaves_like_Metrics_API_resource/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_MRR/behaves_like_Summary/should_have_summary.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_MRR/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_MRRChurnRate/behaves_like_Metrics_API_resource/behaves_like_Summary/should_have_summary.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_MRRChurnRate/behaves_like_Metrics_API_resource/should_have_entries.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Subscription/behaves_like_Pageable/should_be_pageable.yml
+- fixtures/vcr_cassettes/ChartMogul_Metrics_Subscription/should_have_Subscription_entries.yml
+- lib/chartmogul.rb
+- lib/chartmogul/api/actions/all.rb
+- lib/chartmogul/api/actions/create.rb
+- lib/chartmogul/api/actions/custom.rb
+- lib/chartmogul/api/actions/destroy.rb
+- lib/chartmogul/api/actions/update.rb
+- lib/chartmogul/api_resource.rb
+- lib/chartmogul/concerns/entries.rb
+- lib/chartmogul/concerns/pageable.rb
+- lib/chartmogul/concerns/summary.rb
+- lib/chartmogul/config_attributes.rb
+- lib/chartmogul/configuration.rb
+- lib/chartmogul/enrichment/customer.rb
+- lib/chartmogul/errors/chartmogul_error.rb
+- lib/chartmogul/errors/configuration_error.rb
+- lib/chartmogul/errors/forbidden_error.rb
+- lib/chartmogul/errors/not_found_error.rb
+- lib/chartmogul/errors/resource_invalid_error.rb
+- lib/chartmogul/errors/schema_invalid_error.rb
+- lib/chartmogul/import/customer.rb
+- lib/chartmogul/import/customer_invoices.rb
+- lib/chartmogul/import/data_source.rb
+- lib/chartmogul/import/invoice.rb
+- lib/chartmogul/import/line_items/one_time.rb
+- lib/chartmogul/import/line_items/subscription.rb
+- lib/chartmogul/import/plan.rb
+- lib/chartmogul/import/subscription.rb
+- lib/chartmogul/import/transactions/payment.rb
+- lib/chartmogul/import/transactions/refund.rb
+- lib/chartmogul/metrics/activity.rb
+- lib/chartmogul/metrics/all_key_metrics.rb
+- lib/chartmogul/metrics/arpa.rb
+- lib/chartmogul/metrics/arr.rb
+- lib/chartmogul/metrics/asp.rb
+- lib/chartmogul/metrics/base.rb
+- lib/chartmogul/metrics/customer_churn_rate.rb
+- lib/chartmogul/metrics/customer_count.rb
+- lib/chartmogul/metrics/ltv.rb
+- lib/chartmogul/metrics/mrr.rb
+- lib/chartmogul/metrics/mrr_churn_rate.rb
+- lib/chartmogul/metrics/subscription.rb
+- lib/chartmogul/object.rb
+- lib/chartmogul/resource_path.rb
+- lib/chartmogul/summary.rb
+- lib/chartmogul/utils/hash_snake_caser.rb
+- lib/chartmogul/utils/json_parser.rb
+- lib/chartmogul/version.rb
+homepage: https://github.com/chartmogul/chartmogul-ruby
+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.6.5
+signing_key: 
+specification_version: 4
+summary: Chartmogul API Ruby Client
+test_files: []
+has_rdoc: