gifnoc 0.0.1

data/lib/gifnoc/models/model.rb

@@ -0,0 +1,71 @@
+module Gifnoc
+	class Model
+
+		extend TypedAttrAccessor
+
+		def self.attributes_hash
+			return const_get(:ATTRIBUTES)
+		end
+
+		def self.attribute_names
+			return self.attributes_hash.keys
+		end
+
+		def self.api_attribute_names
+			return self.attribute_names & const_get(:API_ATTRIBUTE_LIST)
+		end
+
+		def self.api_attributes_hash
+			return self.attributes_hash.select { |k, _| self.api_attribute_names.include?(k) }
+		end
+
+		def initialize(**args)
+			raise NotImplementedError if self.class == Model
+			self.class.validate_attributes(args)
+			self.class.attribute_names.each { |arg| self.send("#{arg}=", args[arg]) }
+		end
+
+		def to_api_hash
+			return self.class.api_attributes_hash.inject({}) do |hash, (name, type)|
+				value = self.send(name)
+				value = value&.to_s if type == TypedAttrAccessor::TYPE_DATE_TIME
+				hash[name.to_s] = value
+				next(hash)
+			end
+		end
+
+		def self.from_api_hash(api_hash)
+			validate_api_attributes(api_hash)
+			args = api_hash.inject({}) do |hash, (key, value)|
+				case api_attributes_hash[key.to_sym]
+				when TypedAttrAccessor::TYPE_DATE_TIME
+					hash[key.to_sym] = value.nil? ? value : DateTime.iso8601(value)
+				else
+					hash[key.to_sym] = value
+				end
+				hash
+			end
+			return new(**args)
+		end
+
+		private
+
+		def self.validate_api_attributes(args)
+			return validate_attributes_internal(args, self.api_attribute_names)
+		end
+
+		def self.validate_attributes(args)
+			return validate_attributes_internal(args, self.attribute_names)
+		end
+
+		# method should be considered private, but it's called from both an instance method and a class method
+		def self.validate_attributes_internal(args, allowed_arguments)
+			current_arguments = args.keys.map(&:to_sym)
+			allowed_arguments = allowed_arguments.map(&:to_sym)
+			if (current_arguments | allowed_arguments).size > allowed_arguments.size
+				raise ArgumentError, "incorrect arguments: #{self.name} has the following attributes: #{allowed_arguments}"
+			end
+		end
+
+	end
+end

data/lib/gifnoc/models/namespace.rb

@@ -0,0 +1,20 @@
+module Gifnoc
+	class Namespace < Model
+
+		ATTRIBUTES = {
+			uuid: TypedAttrAccessor::TYPE_STRING,
+			name: TypedAttrAccessor::TYPE_STRING,
+			delete_protection: TypedAttrAccessor::TYPE_BOOLEAN,
+			record_count: TypedAttrAccessor::TYPE_INTEGER,
+			created_at: TypedAttrAccessor::TYPE_DATE_TIME,
+			updated_at: TypedAttrAccessor::TYPE_DATE_TIME,
+		}.deep_freeze
+
+		API_ATTRIBUTE_LIST = [:uuid, :name, :delete_protection, :record_count, :created_at, :updated_at].deep_freeze
+
+		attributes_hash.each do |name, type_alias|
+			typed_attr_accessor(name, type_alias)
+		end
+
+	end
+end

data/lib/gifnoc/models/record.rb

@@ -0,0 +1,53 @@
+require "base64"
+
+module Gifnoc
+	class Record < Model
+
+		ATTRIBUTES = {
+			uuid: TypedAttrAccessor::TYPE_STRING,
+			key: TypedAttrAccessor::TYPE_STRING,
+			raw_value: TypedAttrAccessor::TYPE_BASE64,
+			metadata: TypedAttrAccessor::TYPE_HASH,
+			ttl: TypedAttrAccessor::TYPE_INTEGER,
+			created_at: TypedAttrAccessor::TYPE_DATE_TIME,
+			updated_at: TypedAttrAccessor::TYPE_DATE_TIME,
+			last_access: TypedAttrAccessor::TYPE_DATE_TIME,
+			value: TypedAttrAccessor::TYPE_STRING,
+		}.deep_freeze
+
+		API_ATTRIBUTE_LIST = [:uuid, :key, :raw_value, :metadata, :ttl, :created_at, :updated_at, :last_access].deep_freeze
+
+		attributes_hash.each do |name, type_alias|
+			typed_attr_accessor(name, type_alias)
+		end
+
+		# keep raw_value and value in sync, allow calling super for typed_attr_accessor
+		module SetValueSyncer
+			def raw_value=(new_raw_value)
+				super(new_raw_value)
+				new_value = Base64.strict_decode64(new_raw_value) unless new_raw_value.nil?
+				instance_variable_set("@value", new_value)
+				return new_raw_value
+			end
+
+			def value=(new_value)
+				super(new_value)
+				new_raw_value = Base64.strict_encode64(new_value) unless new_value.nil?
+				instance_variable_set("@raw_value", new_raw_value)
+				return new_value
+			end
+
+			def initialize(**args)
+				if args.has_key?(:raw_value) && args.has_key?(:value)
+					raise ArgumentError, "only one of the :raw_value and :value attributes should be provided"
+				end
+				super(**args)
+				self.raw_value = args[:raw_value] if args.has_key?(:raw_value)
+				self.value = args[:value] if args.has_key?(:value)
+			end
+		end
+		private_constant :SetValueSyncer
+		prepend SetValueSyncer
+
+	end
+end

data/lib/gifnoc/models/token.rb

@@ -0,0 +1,20 @@
+module Gifnoc
+	class Token < Model
+
+		ATTRIBUTES = {
+			uuid: TypedAttrAccessor::TYPE_STRING,
+			description: TypedAttrAccessor::TYPE_STRING,
+			secret: TypedAttrAccessor::TYPE_STRING,
+			expiry: TypedAttrAccessor::TYPE_DATE_TIME,
+			created_at: TypedAttrAccessor::TYPE_DATE_TIME,
+			updated_at: TypedAttrAccessor::TYPE_DATE_TIME,
+		}.deep_freeze
+
+		API_ATTRIBUTE_LIST = [:uuid, :description, :secret, :expiry, :created_at, :updated_at].deep_freeze
+
+		attributes_hash.each do |name, type_alias|
+			typed_attr_accessor(name, type_alias)
+		end
+
+	end
+end

data/lib/gifnoc/models/typed_attr_accessor.rb

@@ -0,0 +1,62 @@
+require "base64"
+
+module Gifnoc
+	module TypedAttrAccessor
+
+		TYPE_STRING = :string
+		TYPE_DATE_TIME = :date_time
+		TYPE_BOOLEAN = :boolean
+		TYPE_INTEGER = :integer
+		TYPE_HASH = :hash
+		TYPE_BASE64 = :base64
+
+		def typed_attr_accessor(name, type_alias)
+			define_method(name) do
+				instance_variable_get("@#{name}")
+			end
+
+			define_method("#{name}=") do |value|
+				TypedAttrAccessor.type_checks(type_alias, value)
+				TypedAttrAccessor.type_specific_checks(type_alias, value)
+				instance_variable_set("@#{name}", value)
+			end
+		end
+
+		def self.allowed_types(type_alias)
+			allowed_types = []
+			allowed_types += [NilClass]
+			allowed_types += type_alias_to_type_array(type_alias)
+			return allowed_types
+		end
+
+		def self.type_alias_to_type_array(type_alias)
+			case type_alias
+			when TYPE_STRING
+				return [String]
+			when TYPE_BASE64
+				return [String]
+			when TYPE_DATE_TIME
+				return [DateTime]
+			when TYPE_BOOLEAN
+				return [TrueClass, FalseClass]
+			when TYPE_INTEGER
+				return [Integer]
+			when TYPE_HASH
+				return [Hash]
+			end
+		end
+
+		def self.type_checks(type_alias, value)
+			allowed_types = self.allowed_types(type_alias)
+			raise ArgumentError.new("Invalid Type (allowed #{ allowed_types.inspect })") unless allowed_types.any? { |type| value.is_a?(type) }
+		end
+
+		def self.type_specific_checks(type_alias, value)
+			case type_alias
+			when TYPE_BASE64
+				Base64.strict_decode64(value) if value # raises ArgumentError (invalid base64) if value is not a Base64 string
+			end
+		end
+
+	end
+end

data/lib/gifnoc/version.rb

@@ -0,0 +1,3 @@
+module Gifnoc
+		VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: gifnoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cloud 66
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: ice_nine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.2
+description: 
+email:
+- hello@cloud66.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gifnoc.gemspec
+- lib/gifnoc.rb
+- lib/gifnoc/apis.rb
+- lib/gifnoc/apis/account_api_methods.rb
+- lib/gifnoc/apis/api.rb
+- lib/gifnoc/apis/namespace_api_methods.rb
+- lib/gifnoc/apis/record_api_methods.rb
+- lib/gifnoc/apis/token_api_methods.rb
+- lib/gifnoc/clients.rb
+- lib/gifnoc/clients/account_client_methods.rb
+- lib/gifnoc/clients/client.rb
+- lib/gifnoc/clients/namespace_client_methods.rb
+- lib/gifnoc/clients/record_client_methods.rb
+- lib/gifnoc/clients/token_client_methods.rb
+- lib/gifnoc/exceptions.rb
+- lib/gifnoc/models.rb
+- lib/gifnoc/models/account.rb
+- lib/gifnoc/models/model.rb
+- lib/gifnoc/models/namespace.rb
+- lib/gifnoc/models/record.rb
+- lib/gifnoc/models/token.rb
+- lib/gifnoc/models/typed_attr_accessor.rb
+- lib/gifnoc/version.rb
+homepage: https://github.com/cloud66-oss/gifnoc-ruby
+licenses:
+- Apache-2.0
+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.7.7
+signing_key: 
+specification_version: 4
+summary: A Ruby Gifnoc client implementation
+test_files: []