apisync 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ac6a9c1548e8e2dde54d0f957ef97b9d6949259
-  data.tar.gz: be3397eee31649c642e49bec55741f7cc4cfaa4a
+  metadata.gz: f3baebf434178862cf7ad0513124cfa460f1ed8c
+  data.tar.gz: 89cfa8062601ae2a64b15a52072303789e97f027
 SHA512:
-  metadata.gz: f7dc60dd6dac986fd8aeb6b32b661bbd195a1c1247153f3b2f2e2a82f3f152b8e3b04e62b27c5ee97c1b8d26f3f290262f7b04e7e5c2b1b5002c024be0116a91
-  data.tar.gz: 4728886e023f1740a9069b6715b58e6321169c8e7e3f9eda680b2f1649224ff82884dae24935ef8bcc1b05f9724b35806ebc2b69dc3ed5c63f94f89838720e64
+  metadata.gz: 7e87c8cf404ed809e67588896489dafc1bfcba4a3fdd5e069be68d4f38b38b365f54b9fac016568e15a22c1afbd4b12815a6a03296edcde66e6a62b75f09650e
+  data.tar.gz: c1bd720f4e8700182878c26f649c7b0ddfc10dab926159052194007c22f9646dd22859d7063c7840339058d573dd2278907b4265ef53c75f757240f732c5fb4c

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem

data/README.md

@@ -1,8 +1,6 @@
 # Apisync
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apisync`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This gem gives you the tools to interact with [apisync.io](apisync.io).
 
 ## Installation
 
@@ -12,27 +10,42 @@ Add this line to your application's Gemfile:
 gem 'apisync'
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+## Usage
 
-    $ gem install apisync
+### Vanilla Ruby
 
-## Usage
+To create an inventory item:
 
-TODO: Write usage instructions here
+```ruby
+client = Apisync.new(api_key: token)
+client.inventory_items.save({
+  attributes: {
+    ad_template_type: "vehicle",
+    availability: "on-sale",
+    brand: "brand",
+    condition: "new",
+    content_language: "pt-br"
+    # ... more attributes
+  }
+})
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To run tests:
+
+```
+bundle exec rspec spec
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, update the version number in `version.rb`, and then
+run `bundle exec rake release`, which will create a git tag for the version,
+push git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kurko/apisync.
+Bug reports and pull requests are welcome on GitHub at https://github.com/apisync/apisync-ruby.
 
 ## License
 

data/apisync.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "apisync"
   spec.version       = Apisync::VERSION
   spec.authors       = ["Alexandre de Oliveira"]
-  spec.email         = ["alex@veiculo.online"]
+  spec.email         = ["chavedomundo@gmail.com"]
 
   spec.summary       = %q{Official client to apisync.io}
   spec.homepage      = "https://github.com/apisync/apisync-ruby"
@@ -20,7 +20,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "httparty", "~> 0.13"
+
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "pry"
 end

data/lib/apisync.rb

@@ -1,5 +1,29 @@
+require "bundler/setup"
+require "httparty"
+
 require "apisync/version"
+require "apisync/exceptions"
+require "apisync/resource"
+require "apisync/http_client"
+require "apisync/http/url"
+require "apisync/http/query_string"
+
+class Apisync
+  @@api_key = nil
+
+  def initialize(api_key: nil)
+    @api_key = api_key || @@api_key
+
+    raise ArgumentError, "missing keyword: api_key" if @api_key.nil?
+  end
+
+  def method_missing(name, args = {}, &block)
+    # overrides the instance api_key as `authorization`
+    options = args.merge(api_key: @api_key)
+    Apisync::Resource.new(name, options)
+  end
 
-module Apisync
-  # Your code goes here...
+  def self.api_key=(key)
+    @@api_key = key
+  end
 end

data/lib/apisync/exceptions.rb

@@ -0,0 +1,7 @@
+class Apisync
+  class Exception < StandardError; end
+
+  # List of exceptions. They are all inherited from Apisync::Exception
+  class UrlAndPayloadIdMismatch < Apisync::Exception; end
+  class InvalidFilter < Apisync::Exception; end
+end

data/lib/apisync/http/query_string.rb

@@ -0,0 +1,68 @@
+class Apisync
+  module Http
+    class QueryString
+      def initialize(filters:)
+        @filters = filters
+      end
+
+      def to_s
+        result = ""
+        result << format_filters if @filters
+        result
+      end
+
+      private
+
+      # Takes a list of `[key]=value` strings and maps them adding `"filter"`
+      # as prefix.
+      #
+      # Results in `filter[key]=value&filter[key2]=value2`.
+      def format_filters
+        recursive_brackets(@filters)
+          .flatten
+          .map { |filter| "filter#{filter}" }
+          .join("&")
+      end
+
+      # Takes a hash such as
+      #
+      #   {
+      #     field_one: 'value1',
+      #     metadata: {
+      #       field_two: "value2",
+      #       field_three: "value3"
+      #     }
+      #   }
+      #
+      # and returns
+      #
+      #   [
+      #     "[field-one]=value1",
+      #     "[metadata][field-two]=value2",
+      #     "[metadata][field-three]=value3"
+      #   ]
+      #
+      # This can be used for creating filter querystrings.
+      def recursive_brackets(hash, prefix = "")
+        result = []
+        hash.each do |key, value|
+          key = hyphenize(key.to_s)
+          if value.is_a?(Hash)
+            prefix = "#{prefix}[#{key}]"
+            top_nodes = recursive_brackets(value, prefix)
+            result << top_nodes
+          else
+            result << "#{prefix}[#{key}]=#{value}"
+          end
+        end
+
+        result
+      end
+
+      # Converts application_id in application-id.
+      def hyphenize(string)
+        string.gsub(/_/, "-")
+      end
+    end
+  end
+end

data/lib/apisync/http/url.rb

@@ -0,0 +1,73 @@
+class Apisync
+  module Http
+
+    # Responsible for generating URLs
+    class Url
+      DEFAULT_HOST = "https://api.apisync.io"
+
+      # - resource_name: a name in plural such as 'users', 'profiles' etc.
+      # - id: id of the resource that you're looking for
+      # - filters: these will define what's in the query string, such as
+      #   'filter[application-id]=value'
+      # - options: allows you to pass options such 'host'. Accepted options are
+      #
+      #   - host: a custom host for the URL, defaults to DEFAULT_HOST
+      def initialize(resource_name:, id: nil, filters: nil, options:)
+        @resource_name = resource_name
+        @id = id
+        @filters = filters
+        @options = {
+          host: nil
+        }.merge(options)
+      end
+
+      # to_s
+      #
+      # Takes a host, api_version, resource name and id and form the URL. Then
+      # pass filters and other options into QueryString class which will return
+      # whatever is after the `?` symbol.
+      #
+      # Returns a string such as
+      #
+      #    'https://api.apisync.io/inventory-items?filter[application-id]=abc'
+      #
+      # If there are no query strings, omits the `?`
+      #
+      #    'https://api.apisync.io/inventory-items'
+      #
+      def to_s
+        url = [
+          host,
+          api_version,
+          normalized_resource_name,
+          @id
+        ].compact.join("/")
+        url = remove_duplicated_slashes(url)
+        [url, query_string].compact.join("?")
+      end
+
+      private
+
+      def api_version
+        Apisync::HttpClient::VERSION_PREFIX
+      end
+
+      def host
+        @options[:host] || DEFAULT_HOST
+      end
+
+      def query_string
+        str = Apisync::Http::QueryString.new(filters: @filters).to_s
+        str if str != ""
+      end
+
+      def normalized_resource_name
+        @resource_name.to_s.downcase.gsub("_", "-")
+      end
+
+      def remove_duplicated_slashes(string)
+        string.gsub(/([^:])\/\//, '\1/')
+      end
+    end
+  end
+end

data/lib/apisync/http_client.rb

@@ -0,0 +1,74 @@
+class Apisync
+  class HttpClient
+    VERSION_PREFIX = "".freeze
+
+    HEADER = {
+      "Content-Type" => "application/vnd.api+json",
+      "Accept"       => "application/vnd.api+json"
+    }.freeze
+
+    def self.post(resource_name:, data:, options: {})
+      url = Apisync::Http::Url.new(
+        resource_name: resource_name,
+        options: options
+      )
+      payload = payload_from_data(data)
+      HTTParty.post(
+        url.to_s,
+        body: {data: payload}.to_json,
+        headers: header(api_key: options[:api_key])
+      )
+    end
+
+    def self.put(resource_name:, id:, data:, options: {})
+      raise Apisync::UrlAndPayloadIdMismatch unless id == data[:id]
+
+      url = Apisync::Http::Url.new(
+        resource_name: resource_name,
+        id: id,
+        options: options
+      )
+      payload = payload_from_data(data)
+      HTTParty.put(
+        url.to_s,
+        body: {data: payload}.to_json,
+        headers: header(api_key: options[:api_key])
+      )
+    end
+
+    def self.get(resource_name:, id: nil, filters: nil, options: {})
+      raise Apisync::InvalidFilter if !filters.nil? && !filters.is_a?(Hash)
+
+      url = Apisync::Http::Url.new(
+        resource_name: resource_name,
+        id: id,
+        filters: filters,
+        options: options
+      )
+      HTTParty.get(url.to_s, headers: header(api_key: options[:api_key]))
+    end
+
+    private
+
+    def self.header(api_key: nil)
+      final = HEADER
+      if api_key
+        final = final.merge("Authorization" => "ApiToken #{api_key}")
+      end
+      final
+    end
+
+    def self.payload_from_data(data)
+      transformed_payload = {}
+      data.each do |key, value|
+        if value.is_a?(Hash)
+          transformed_payload[key.to_s] = payload_from_data(value)
+        else
+          new_key = key.to_s.gsub("_", "-").to_sym
+          transformed_payload[new_key] = value
+        end
+      end
+      transformed_payload
+    end
+  end
+end

data/lib/apisync/resource.rb

@@ -0,0 +1,67 @@
+class Apisync
+  class Resource
+    def initialize(name, options = {})
+      @name = name
+      @options = options
+    end
+
+    # Saves a resource.
+    #
+    # When the resource has an id in `data`, a `PUT` request is done. Otherwise
+    # a `POST` takes place.
+    #
+    def save(data)
+      data[:type] = @name.to_s.gsub("_", "-")
+      if data[:id].nil?
+        post(data)
+      else
+        put(data)
+      end
+    end
+
+    # Returns all resources that match the conditions passed in.
+    #
+    # 1. To find a resource by its id:
+    #
+    #   get(id: 'customer-id')
+    #
+    # 2. To find a resource by a column value
+    #
+    #   get(filters: {column_name: 'customer-id' }})
+    #
+    def get(conditions)
+      http_client.get(
+        resource_name: @name,
+        id: conditions[:id],
+        filters: conditions[:filters],
+        options: @options
+      )
+    end
+
+    private
+
+
+    def post(data)
+      http_client.post(
+        resource_name: @name,
+        data: data,
+        options: @options
+      )
+    end
+
+    def put(data)
+      http_client.put(
+        resource_name: @name,
+        id: data[:id],
+        data: data,
+        options: @options
+      )
+    end
+
+    private
+
+    def http_client
+      Apisync::HttpClient
+    end
+  end
+end

data/lib/apisync/version.rb

@@ -1,3 +1,3 @@
-module Apisync
-  VERSION = "0.1.0"
+class Apisync
+  VERSION = "0.1.3"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: apisync
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Alexandre de Oliveira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-10 00:00:00.000000000 Z
+date: 2017-10-10 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,9 +66,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
-- alex@veiculo.online
+- chavedomundo@gmail.com
 executables:
 - console
 - setup
@@ -72,6 +114,11 @@ files:
 - bin/console
 - bin/setup
 - lib/apisync.rb
+- lib/apisync/exceptions.rb
+- lib/apisync/http/query_string.rb
+- lib/apisync/http/url.rb
+- lib/apisync/http_client.rb
+- lib/apisync/resource.rb
 - lib/apisync/version.rb
 homepage: https://github.com/apisync/apisync-ruby
 licenses: