hipcall 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0714276b651ff95a6fde2b7c36c85acc5e6170065e4a8d07e52712543a35ae1c
+  data.tar.gz: 80f7fb286ead1667610808cdccb697422976dc54b90fd33481aed108d1c4c829
+SHA512:
+  metadata.gz: 343a8bfbf09322c45e6bd0b3f4149032b3039a01d95a3aef55fdd875be8e6b034ebcf51c511a42d7f4b2ad1413dfe63240bad0f93100c43592e3f662c6693e84
+  data.tar.gz: b2d507c8517047aea14069905e5ad57aa11ed8bc5f95e93e0f7182a65b9f439388110c8a722133716c54dadc68c6f0d70bc85a03a07a1ebec075e42b4e8c9e6c

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## v1.0.0
+
+### Features
+
+- Add cdr resource
+- Add number resource
+- Add task resource
+- Add user resource

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:3.0
+
+# throw errors if Gemfile has been modified since Gemfile.lock
+RUN bundle config --global frozen 1
+
+WORKDIR /usr/src/hipcall-sdk
+
+COPY . .
+
+RUN bundle install
+
+CMD bash

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hipcall.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", ">= 5.0.5"
+gem "standard"

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    hipcall (1.0.0)
+      faraday (~> 1.10)
+      faraday_middleware (~> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    faraday (1.10.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0)
+      faraday-multipart (~> 1.0)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.0)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      faraday-retry (~> 1.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-multipart (1.0.4)
+      multipart-post (~> 2)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday-retry (1.0.3)
+    faraday_middleware (1.2.0)
+      faraday (~> 1.0)
+    minitest (5.16.2)
+    multipart-post (2.2.3)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  hipcall!
+  minitest (>= 5.0.5)
+  rake (~> 13.0)
+  standard
+
+BUNDLED WITH
+   2.2.33

data/README.md

@@ -0,0 +1,76 @@
+# Hipcall
+
+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/hipcall`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hipcall'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hipcall
+
+## Usage
+
+```ruby
+hipcall = Hipcall::Client.new(api_key: "YOUR_TOKEN_IS_HERE", version: "v20211124", base_url: "https://app.hipcall.com.tr/api/")
+```
+
+### Cdr resource
+
+```ruby
+# List
+cdrs = hipcall.cdrs.list
+
+# Retrieve
+year = 2022
+mounth = 07
+day = 07
+cdr_uuid = "caedfd1b-25ec-447e-ad87-3b7eb3d358ea"
+cdr = hipcall.cdrs.retrieve(year: year, mounth: mounth, day: day, cdr_uuid: cdr_uuid)
+```
+
+### Number resource
+
+```ruby
+# List
+numbers = hipcall.numbers.list
+
+# Retrieve
+number = hipcall.numbers.retrieve(number_id: 1)
+```
+
+### Task resource
+
+```ruby
+# List
+tasks = hipcall.tasks.list
+
+# Retrieve
+task = hipcall.tasks.retrieve(task_id: 1)
+
+# Create
+new_task = hipcall.tasks.create(name: 'Lets email the contact')
+```
+
+### User resource
+
+```ruby
+# List
+users = hipcall.users.list
+
+# Retrieve
+user = hipcall.users.retrieve(user_id: 1)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hipcall/ruby-sdk .

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test
+
+task :console do
+  exec "irb -I lib -r hipcall.rb"
+end

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hipcall"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+client = Hipcall::Client.new(api_key: ENV["HIPCALL_API_KEY"])
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hipcall.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/hipcall/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "hipcall"
+  spec.version = Hipcall::VERSION
+  spec.authors = ["Hipcall Development Team", "Onur Ozgur OZKAN"]
+  spec.email = ["hello@hipcall.com"]
+
+  spec.summary = "Hipcall's Ruby SDK"
+  spec.homepage = "https://www.hipcall.com"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hipcall/ruby-sdk"
+  spec.metadata["changelog_uri"] = "https://github.com/hipcall/ruby-sdk/blob/master/CHANGELOG.md"
+  spec.licenses = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "faraday", "~> 1.10"
+  spec.add_dependency "faraday_middleware", "~> 1.2"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/hipcall/client.rb

@@ -0,0 +1,41 @@
+require "faraday"
+require "faraday_middleware"
+
+module Hipcall
+	class Client
+		attr_reader :api_key, :version, :base_url, :adapter
+
+		def initialize(api_key:, version: "v20211124", base_url: "https://app.hipcall.com/api/", adapter: Faraday.default_adapter, stubs: nil)
+			@api_key = api_key
+			@version = version
+			@base_url = base_url
+			@adapter = adapter
+			@stubs = stubs
+		end
+
+		def cdrs
+			CdrResource.new(self)
+		end
+
+		def numbers
+			NumberResource.new(self)
+		end
+
+		def tasks
+			TaskResource.new(self)
+		end
+
+		def users
+			UserResource.new(self)
+		end
+
+		def connection
+			@connection ||= Faraday.new (base_url + version) do |connection|
+				connection.request :authorization, :Bearer, api_key
+				connection.request :json, :accept => 'application/json'
+				connection.response :json, content_type: "application/json"
+				connection.adapter adapter, @stubs
+			end
+		end
+	end
+end

data/lib/hipcall/collection.rb

@@ -0,0 +1,20 @@
+module Hipcall
+	class Collection
+		attr_reader :data, :links, :meta
+
+		def self.from_response(response, key:, type:)
+			body = response.body
+			new(
+				data: body[key].map { |attrs| type.new(attrs) },
+				links: body["links"],
+				meta: body["meta"],
+			)
+		end
+
+		def initialize(data:, links:, meta:)
+			@data = data
+			@links = links
+			@meta = meta
+		end
+	end
+end

data/lib/hipcall/error.rb

@@ -0,0 +1,4 @@
+module Hipcall
+	class Error < StandardError
+	end
+end

data/lib/hipcall/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module Hipcall
+	class Object < OpenStruct
+		def initialize(attributes)
+			super to_ostruct(attributes)
+		end
+		
+		def to_ostruct(obj)
+			if obj.is_a?(Hash)
+				OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+			elsif obj.is_a?(Array)
+				obj.map { |o| to_ostruct(o) }
+			else # Assumed to be a primitive value
+				obj
+			end
+		end
+	end
+end

data/lib/hipcall/objects/cdr.rb

@@ -0,0 +1,4 @@
+module Hipcall
+	class Cdr < Object
+	end
+end

data/lib/hipcall/objects/number.rb

@@ -0,0 +1,4 @@
+module Hipcall
+	class Number < Object
+	end
+end

data/lib/hipcall/objects/task.rb

@@ -0,0 +1,4 @@
+module Hipcall
+	class Task < Object
+	end
+end

data/lib/hipcall/objects/user.rb

@@ -0,0 +1,4 @@
+module Hipcall
+	class User < Object
+	end
+end

data/lib/hipcall/resource.rb

@@ -0,0 +1,53 @@
+module Hipcall
+	class Resource
+		attr_reader :client
+
+		def initialize(client)
+			@client = client
+		end
+
+		private
+
+		def get_request(url, params: {}, headers: {})
+			handle_response client.connection.get(url, params, headers)
+		end
+	
+		def post_request(url, body:, headers: {})
+			handle_response client.connection.post(url, body, headers)
+		end
+	
+		def patch_request(url, body:, headers: {})
+			handle_response client.connection.patch(url, body, headers)
+		end
+	
+		def put_request(url, body:, headers: {})
+			handle_response client.connection.put(url, body, headers)
+		end
+	
+		def delete_request(url, params: {}, headers: {})
+			handle_response client.connection.delete(url, params, headers)
+		end
+
+		def handle_response(response)
+			message = response.body["errors"]
+			case response.status
+			when 400
+				raise Error, message
+			when 401
+				raise Error, message
+			when 403
+				raise Error, message
+			when 404
+				raise Error, message
+			when 419 
+				raise Error, message
+			when 429
+				raise Error, message
+			when 500
+				raise Error, message
+			end
+
+			response
+		end
+	end
+end

data/lib/hipcall/resources/cdrs.rb

@@ -0,0 +1,12 @@
+module Hipcall
+	class CdrResource < Resource
+		def list(**params)
+			response = get_request("cdrs", params: params)
+			Collection.from_response(response, key: "data", type: Cdr)
+		end
+
+		def retrieve(year:, mounth:, day:, cdr_uuid:)
+			Cdr.new get_request("cdrs/#{year}/#{mounth}/#{day}/#{cdr_uuid}").body.dig("data")
+		end
+	end
+end

data/lib/hipcall/resources/numbers.rb

@@ -0,0 +1,12 @@
+module Hipcall
+	class NumberResource < Resource
+		def list(**params)
+			response = get_request("numbers", params: params)
+			Collection.from_response(response, key: "data", type: Number)
+		end
+
+		def retrieve(number_id:)
+			Number.new get_request("numbers/#{number_id}").body.dig("data")
+		end
+	end
+end

data/lib/hipcall/resources/tasks.rb

@@ -0,0 +1,16 @@
+module Hipcall
+	class TaskResource < Resource
+		def list(**params)
+			response = get_request("tasks", params: params)
+			Collection.from_response(response, key: "data", type: Task)
+		end
+
+		def retrieve(task_id:)
+			Task.new get_request("tasks/#{task_id}").body.dig("data")
+		end
+
+		def create(**attributes)
+			Task.new post_request("tasks", body: attributes).body.dig("data")
+		end
+	end
+end

data/lib/hipcall/resources/users.rb

@@ -0,0 +1,12 @@
+module Hipcall
+	class UserResource < Resource
+		def list(**params)
+			response = get_request("users", params: params)
+			Collection.from_response(response, key: "data", type: User)
+		end
+
+		def retrieve(user_id:)
+			User.new get_request("users/#{user_id}").body.dig("data")
+		end
+	end
+end

data/lib/hipcall/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hipcall
+  VERSION = "1.0.0"
+end

data/lib/hipcall.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "hipcall/version"
+
+module Hipcall
+  autoload :Client, "hipcall/client"
+  autoload :Collection, "hipcall/collection"
+  autoload :Error, "hipcall/error"
+  autoload :Object, "hipcall/object"
+  autoload :Resource, "hipcall/resource"
+
+
+  autoload :Cdr, "hipcall/objects/cdr"
+  autoload :Number, "hipcall/objects/number"
+  autoload :Task, "hipcall/objects/task"
+  autoload :User, "hipcall/objects/user"
+
+  autoload :CdrResource, "hipcall/resources/cdrs"
+  autoload :NumberResource, "hipcall/resources/numbers"
+  autoload :TaskResource, "hipcall/resources/tasks"
+  autoload :UserResource, "hipcall/resources/users"
+end

data/sig/hipcall/hipcall.rbs

@@ -0,0 +1,4 @@
+module Hipcall
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: hipcall
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Hipcall Development Team
+- Onur Ozgur OZKAN
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email:
+- hello@hipcall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hipcall.gemspec
+- lib/hipcall.rb
+- lib/hipcall/client.rb
+- lib/hipcall/collection.rb
+- lib/hipcall/error.rb
+- lib/hipcall/object.rb
+- lib/hipcall/objects/cdr.rb
+- lib/hipcall/objects/number.rb
+- lib/hipcall/objects/task.rb
+- lib/hipcall/objects/user.rb
+- lib/hipcall/resource.rb
+- lib/hipcall/resources/cdrs.rb
+- lib/hipcall/resources/numbers.rb
+- lib/hipcall/resources/tasks.rb
+- lib/hipcall/resources/users.rb
+- lib/hipcall/version.rb
+- sig/hipcall/hipcall.rbs
+homepage: https://www.hipcall.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.hipcall.com
+  source_code_uri: https://github.com/hipcall/ruby-sdk
+  changelog_uri: https://github.com/hipcall/ruby-sdk/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: Hipcall's Ruby SDK
+test_files: []